LaTeX Workshop is an extension for Visual Studio Code, aiming to provide core features for LaTeX typesetting with Visual Studio Code.
This project won't be successful without contributions from the community, especially from the current and past key contributors:
- Jerome Lelong
@jlelong
- Takashi Tamura
@tamuratak
- Tecosaur
@tecosaur
- James Booth
@jabooth
Thank you so much!
Note that the latest version of LaTeX-Workshop requires at least VSCode 1.67.0
.
The manual of the extension is maintained as a wiki
- Home
- Installation and basic settings
- Compiling
- Linting
- Viewing & SyncTeX
- Formatting
- Intellisense
- Snippets and shortcuts
- Hovering and previewing features
- Playing with environments
- Extra features
- VS Code Remote Development
- FAQ and common issues
This is not a complete list but rather a preview of some of the coolest features.
-
Build LaTeX (including BibTeX) to PDF automatically on save.
-
View PDF on-the-fly (in VS Code or browser).
-
Direct and reverse SyncTeX. Click to jump between location in
.tex
source and PDF and vice versa. -
Intellisense, including completions for bibliography keys (
\cite{}
) and labels (\ref{}
). -
LaTeX log parser, with errors and warnings in LaTeX build automatically reported in VS Code.
- Linting
-
-
A lot of LaTeX commands can be typed using snippets starting in
\
, then type part of the command to narrow the search. -
Surround some selected text with a LaTeX command using ctrl+l, ctrl+w (β+l, β+w on Mac). A new menu pops up to select the command. This works with multi selections. The former approach using
\
has been deprecated. -
We also provide a few other suggestion mechanisms
-
Greek letters are obtained as
@
+letter
. Some letters have variants, which are available as@v
+letter
. See here. -
Common environments can be obtained by
BXY
whereXY
are the first two letters of the environment name, eg.BEQ
gives theequation
environment. If you want the star version of the environment, useBSXX
, eg.BSEQ
gives theequation*
environment. See here. -
Common font commands can be obtained by
FXY
whereXY
are the last two letters of the font command name, eg.FIT
gives\textit{}
. See here. -
Many other maths symbols can be obtained with the
@
prefix. See here.
-
-
-
When the current line starts with
\item
or\item[]
, hittingEnter
automatically adds a newline starting in the same way. For a better handling of the last item, hittingEnter
on a line only containing\item
or\item[]
actually deletes the content of the line. Thealt+Enter
is bind to the standard newline command. This automatic insertion of\item
can be deactivated by settinglatex-workshop.bind.enter.key
tofalse
. -
Preview on hover. Hovering over the start tag of a math environment causes a mathjax preview to pop up.
The code for this extension is available on github at: https://github.com/James-Yu/LaTeX-Workshop
- π Star this project on GitHub and Visual Studio Marketplace
- π Leave a comment
βΊοΈ Thank the develops and community for their effort.