In this tutorial, I will guide you through setting up a LaTeX editor on Atom, and here are some reasons and benefits for doing so:
- preview your work side by side as you save your work
- fast, generate previews in 3-seconds
- clicking on the preview will bring your cursor to the syntax’s location
- Dropbox and GitHub integration for backup and working with collaborators
LaTeX is a document preparation system that is widely used in academia for publishing scientific documents. Authors use markup syntax to define the structure of a document, to stylise text, to insert images, to add citations and cross-references.
Because there are so many publishers, each having their design standards. For example, 18pt Times Roman for the title, 12pt Times Italic for the name, and so on. The purpose of LaTeX is to let authors focus on the writing and not wasting time following publishers’ document design guidelines. Authors simply download publishers’ LaTeX template and start writing.
If you’re new to TeX or just want to use LaTeX for a one-time project, the quickest way to get started is using online services like Papeeria, Overleaf, and LaTeX base. They offer the ability to edit, preview, and download your work in PDF format.
Since there are online solutions, so why set up a LaTeX editor on your machine?
Unless you are paying for their plans, the free tier has some limitations, let me list a few:
- Limited private documents [Papeeria], or no private document [Latex base]
- No GitHub integration [Overleaf], or only public repositories [Papeeria]
- No collaborators [Overleaf]
- Need to be online.
Personally, I choose to set up LaTeX on my local so that my co-authors and I can work on the same LaTeX document and sync with private GitHub repositories.
Secondly, unlike online services, generating a preview on a local machine is much quicker too. When I will hit Cmd+S, the preview will be generated in 3-seconds.
In this section, I will guide you through setting up a LaTex editor on Atom on macOS. The setup consists of 4 parts:
- setup TeX distributions
- setup Atom
- install Latexmk
- install packages in Atom
On OS X, download MacTeX. As of April 2020, the distribution is MacTeX-2020. You can choose to download the full package, which is 4GB. It contains all the files that most users need, and you don’t have to face the daunting task of searching for missing components. Highly recommended.
If you don’t want to install the entire MacTeX distribution — which is pretty big, and if you are someone like me who prefers to select what gets installed, you can download BasicTeX, which is only 80MB. BasicTeX contains the TeX Live distribution that suffices the need to generate PDF from .tex files; it does not include GUI applications, Ghostscript, and other libraries. But this means that you have to search and download all the packages you may need. I will cover this later.
MacTeX is for OS X. But if you are on Linux or Windows, download TeX Live.
Atom is a beautiful text editor that is available on OS X, Windows, and Linux. It has a package manager that allows you to install thousands of open source packages that add new features and functionality to your editor. You can easily browse your project files on a single interface. You can split your interface into multiple panes to edit/reference code across files. Download and install Atom.
Latexmk is needed to automate the process of generating a LaTeX document. Nothing to explain here, we need this to work. The installation is simple, from the Terminal, type:
sudo tlmgr install latexmk
This will prompt you for your password and install the latexmk package.
These packages enable you to use Atom as a LaTeX editor.
- Compile. Latex package compiles LaTeX documents from within Atom. It will execute Latexmk to build your work.
- Preview PDF. PDF View package enables you to view PDF files in Atom. This allows you to preview your work side-by-side. Clicking on the preview will bring your cursor to the syntax's location.
- Syntax highlighting. Language-LaTeX package does LaTeX syntax highlighting in Atom. It is particularly useful to help you check that your syntax has valid LaTeX grammar.
At this point, you should have a working LaTeX editor on your Atom. I recommend a few changes to the configurations. Go to Atom -> Preferences -> Packages. Go to Settings of the latex package.
- [check] Build on Save
- [uncheck] Open Result after Successful Build
- [uncheck] Open Result in Background
- Under Output Directory, type “build”
In language-latex package:
- [check] Soft Wrap
If you have download BasicTeX, chances are you have to download packages that publishers use in their templates. The easiest way is to Google search for the missing packages, or search Comprehensive TEX Archive Network (CTAN).
For example, algorithmic is one of the commonly used packages, and we might see this in the document.
To install packages, open the Terminal, type:
sudo tlmgr install algorithms