apm install latex
Compile LaTeX or knitr documents from within Atom.
Use the Atom package manager and search for “latex”, or run
apm install latex
from the command line.
### TeX distribution
Since this package relies upon
latexmk, a reasonably up-to-date and working
TeX distribution is required. The only officially supported distributions are
TeX Live, and MiKTeX. Although, the latter is not as well tested and
supported as TeX Live, hence using TeX Live is highly recommended.
You need to ensure that the package can find your TeX distribution’s binaries;
by default the package uses your
PATH environment variable, as well as the
following search paths on Linux and macOS
and on Windows it uses
If your TeX distribution’s binaries are not installed in one of those locations
or discoverable via the
PATH environment variable, you will need to help the
package find the binaries. This can be done by setting the TeX Path
configuration option to point to the folder containing the binaries, either in
the settings view, or directly in your
config.cson file. See Configuration
for further details regarding the settings of this package.
If you’re using TeX Live and have installed to the default location then no further action should be required.
If you’re using MikTeX and have not installed the required
learn how to use
latexmk with MiKTeX.
latex:build command can be invoked from the LaTex menu or by pressing the
default keybind ctrl-alt-b while in a LaTex or
knitr file. Log messages and any other messages from the build may be seen in
the LaTeX log panel accessible from the status bar.
latex package supports other commands as detailed in the table below.
||ctrl-alt-b||Build LaTeX/knitr file and open result.|
||None||Force a rebuild of LaTeX/knitr file.|
||ctrl-alt-c||Cleanup files after a build.|
||None||Terminate currently running build. Also available from status indicator.|
||ctrl-alt-s||Use SyncTeX forward if possible from the current cursor position.|
||None||Display and highlight log messages from the current cursor position.|
||None||Check for the existence of
Overriding Build settings
Many of the build settings in the settings page of the
latex package can be
overridden on a per file basis. One way to override specific build settings is
to use “magic” TeX comments in the form of
% !TEX <name> = <value>. Another
way is to use a YAML formatted file with the same name as your root LaTeX
file, but with an extension of
.yaml. The settings and values that can
overridden via either method are listed in the table below. If multiple setting
names are listed then the first is preferred and following names are available
for compatibility. More details can found at Overridding Build Settings.
||comma separated patterns, e.g.
||Specify patterns to use for
||Override SyncTeX setting|
||Override extended build mode setting|
||Override shell escape setting|
||Override the LaTeX engine to use for build.|
||Override move result to source directory setting|
||Override the output format|
||comma separated names, e.g.
||Control the number and names of build jobs. Only a single name can be used for
||directory path, e.g.
||Specify the output directory that should be used.|
||Override the PDF producer|
||file path, e.g.
||Specify the root file that should be built. Only available via “magic” TeX comments.|
latex package currently supports Atril, Evince, Okular, pdf-view,
Preview, Skim, Sumatra PDF, Windows shell open, xdg-open, Xreader and
Zathura as PDF/DVI/PS viewers. This includes support for cursor
synchronization via SyncTeX if possible. Specific features of each of the
viewers is detailed at Supported Viewers.
Please note that this package is in a beta state. It is stable, but lacks some important features.
Any and all help is greatly appreciated!