Supported options

buildOnSave

Default: false

Automatically run builds when files are saved.

cleanPatterns

Default: **/*.aux, **/*.aux.bak, **/*.bbl, **/*.bcf, **/*.blg, **/*.dvi, **/*.fdb_latexmk, **/*.fls, **/*.idx, **/*.idx.bak, **/*.ilg, **/*.ind, **/*.lof, **/*.log, **/*.lol, **/*.lot, **/*.nav, **/*.out, **/*.pdf, **/*.ps, **/*.snm, **/*.synctex.gz, **/*.toc, /**/_minted-{jobname}, /{output_dir}/sage-plots-for-{jobname}.tex, /missfont.log, /texput.log, /texput.aux

The files and directories to remove during a LaTeX clean. Basic glob patterns are understood and named properties such as {jobname} are replaced with the current build properties. Patterns that start with / or \\ are matched against any file in the same directory as the source file. All other patterns are matched against generated files in the output directory. For instance, **/*.aux will match any aux file in the generated file in the file name database in any subdirectory, whereas *.aux will match only those files with an aux extension in the output directory.

customEngine

Default: (blank)

Custom LaTeX engine which overrides engine.

enableExtendedBuildMode

Default: true

Enable extended build mode using latexmk rules for custom files types. Currently includes support for Asymptote, the glossaries package, the index package, MetaPost, the nomencl package and SageTeX. Please note that these rules are loaded after all other latexmkrc files are loaded, and therefore may overwrite custom rules defined by the user.

enableShellEscape

Default: false

Enables the shell escape or \write18{} functionality which enables TeX executables to spawn processes for e.g. gnuplot, pygmentize, and so forth, during execution.

See http://wiki.contextgarden.net/Write18 for more details.

enableSynctex

Default: true

Enable SyncTeX forward/backward if supported by the current viewer.

engine

Default: pdflatex — Supported: pdflatex, lualatex, platex, uplatex, xelatex.

Specifies which typesetting engine to use during building. Currently only supported when using latexmk.

loggingLevel

Default: warning - Supported: error, warning, info.

The minimum level of message severity to output in the logger. A logging level of error shows only messages indicating catastrophic issues such as undefined symbols, warning shows error messages and messages indicating unintended consequences such as bad boxes, and info shows all messages including purely informational messages such a font loading.

moveResultToSourceDirectory

Default: true

Ensures that the output file produced by a successful build is stored together with the TeX document that produced it. Only useful if you're using the outputDirectory configuration option, since setting this option to true moves the resulting PDF file from the output directory to the parent directory of the file that was built.

okularPath

Default: /usr/bin/okular

Full application path to Okular (Linux).

opener

Default: automatic - Supported: automatic, atril, evince, okular, pdf-view, preview, shell-open, skim, sumatra, xdg-open, x-reader, zathura, custom

Default opener to use for viewing PDF, PS or DVI files. automatic will result in atom-latex choosing the best opener based on capabilities such as SyncTeX support or ability to open the result in the background if that feature is enabled.

openResultAfterBuild

Default: true

Controls whether to automatically open the resulting PDF/PS/DVI after a successful build.

openResultInBackground

Default: true

Specifies whether Atom should retain focus when opening the PDF/PS/DVI file.

outputDirectory

Default: (blank)

All files generated during a build will be redirected here. Leave blank if you want the build output to be stored in the same directory as the TeX document.

outputFormat

Default: pdf - Supported: pdf, dvi, ps

Output file format. DVI and PS currently only supported for latexmk.

producer

Default: dvipdfmx - Supported: dvipdfmx, xdvipdfmx, dvipdf, ps2pdf

Program to use when post-processing DVI output in order to produce PDF. This is only used for LaTeX engines not capable of natively producing PDF. Currently only supported for latexmk.

skimPath

Default: /Applications/Skim.app

Full application path to Skim (OS X).

sumatraPath

Default: C:\Program Files (x86)\SumatraPDF\SumatraPDF.exe

Full application path to SumatraPDF (Windows).

zathuraPath

Default: /usr/bin/zathura

Full application path to Zathura (Linux).

viewerPath

Default: (blank)

Full application path to your custom PDF viewer. Overrides Skim and SumatraPDF options. Does not support synchronization functionality.

texPath

Default: (blank)

The full path to your TeX distribution's bin directory. Supports $PATH substitution.

If left blank the assumption is that your TeX distribution's binaries are installed in one of following search paths on Linux and macOS

1. /usr/texbin
2. /Library/TeX/texbin

while Windows the search paths are

1. %SystemDrive%\texlive\2017\bin\win32
2. %SystemDrive%\texlive\2016\bin\win32
3. %SystemDrive%\texlive\2015\bin\win32
4. %ProgramFiles%\MiKTeX 2.9\miktex\bin\x64
5. %ProgramFiles(x86)%\MiKTeX 2.9\miktex\bin