mirror of https://github.com/James-Yu/LaTeX-Workshop.git synced 2024-12-04 06:02:50 +03:00

Boost LaTeX typesetting efficiency with preview, compile, autocomplete, colorize, and more.

Go to file

James Yu 39e25b9a7b Update package settings		2024-12-03 22:07:12 +08:00
.devcontainer
.github	Add back GitHub Actions on PR	2024-10-01 17:44:40 +08:00
.vscode
data	Update package suggestions	2024-10-14 12:41:34 +08:00
demo_media
dev	Version 10.7.0	2024-12-03 21:35:15 +08:00
icons
resources	Update unified to 1.8.1	2024-10-22 18:19:40 +08:00
samples
scripts
src	Correct binary file polling comparison	2024-11-25 19:22:00 +08:00
syntax	Update grammar files to jlelong/vscode-latex-basics@3ee9a1f346	2024-09-20 11:06:40 +02:00
test	Add tests to `latex.extraExts` config item	2024-11-23 19:53:13 +08:00
types	Add a config `view.pdf.toolbar.hide.timeout` to control toolbar hiding timeout	2024-10-13 13:19:56 +08:00
viewer	Version 10.7.0	2024-12-03 21:35:15 +08:00
.gitattributes
.gitignore
.vscodeignore	Update package settings	2024-12-03 22:07:12 +08:00
CHANGELOG.md	Version 10.7.0	2024-12-03 21:35:15 +08:00
CONTRIBUTING.md
eslint.config.mjs	Adapt to eslint v9 and fix all issues	2024-09-06 10:38:16 +08:00
LICENSE.txt
package-lock.json	Update package settings	2024-12-03 22:07:12 +08:00
package.json	Update package settings	2024-12-03 22:07:12 +08:00
package.nls.bg.json
package.nls.cs.json
package.nls.de.json
package.nls.es.json
package.nls.fr.json
package.nls.hu.json
package.nls.it.json
package.nls.ja.json
package.nls.json
package.nls.ko.json
package.nls.pl.json
package.nls.pt-br.json
package.nls.ru.json
package.nls.tr.json
package.nls.zh-cn.json
package.nls.zh-tw.json
README.md
tsconfig.eslint.json
tsconfig.eslint.viewer.json
tsconfig.json

README.md

Visual Studio Code LaTeX Workshop Extension

$version$ $updated$ $release$

$downloads$ $installs$ $rating$

$TeX Live on Windows$ $TeX Live on macOS$ $TeX Live on Linux$

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.88.0 (March 2024 or later).

Manual

The manual of the extension is maintained as a wiki

Features (Taster)

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.
$build process gif$
View PDF on-the-fly (in VS Code or browser).
$demo of preview feature$
Direct and reverse SyncTeX. Click to jump between location in .tex source and PDF and vice versa.
$demo of SyncTeX$
Intellisense, including completions for bibliography keys (\cite{}) and labels (\ref{}).
$intellisense demo$
LaTeX log parser, with errors and warnings in LaTeX build automatically reported in VS Code.
- Linting
Snippets
- A lot of LaTeX commands can be typed using snippets starting in \, then type part of the command to narrow the search.
  $auto \item demo$
- 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.
  $wrap demo$
- 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 where XY are the first two letters of the environment name, eg. BEQ gives the equation environment. If you want the star version of the environment, use BSXX, eg. BSEQ gives the equation* environment. See here.
  - Common font commands can be obtained by FXY where XY 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.
    $\frac shortcut demo$ $\int shortcut demo$
Shortcuts
- In addition to snippets, there are shortcuts provided by the extension that allow you to easily format text (and one or two other things).
  $\emph{} demo$
When the current line starts with \item or \item[], hitting Enter automatically adds a newline starting in the same way. For a better handling of the last item, hitting Enter on a line only containing \item or \item[] actually deletes the content of the line. The alt+Enter is bind to the standard newline command. This automatic insertion of \item can be deactivated by setting latex-workshop.bind.enter.key to false.
$auto \item demo$
Preview on hover. Hovering over the start tag of a math environment causes a mathjax preview to pop up.
$equation hover demo$