mirror of https://github.com/James-Yu/LaTeX-Workshop.git synced 2024-10-05 07:37:24 +03:00

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

Go to file

Takashi Tamura 8bfb059caf recommend eslint in CONTRIBUTING.md		2019-08-02 07:04:38 +09:00
.devcontainer	make docker image smaller	2019-05-08 07:35:33 +09:00
.github/ISSUE_TEMPLATE	ask users whether they are using VS Code Remote.	2019-07-24 08:18:26 +09:00
.vscode	add option to launch with a sample TeX file.	2019-05-05 13:09:15 +09:00
data	Change select-envname to handle \[...\].	2019-05-08 15:47:10 -04:00
demo_media	rm demo_media/tikz-preview.gif	2019-08-01 22:41:38 +09:00
dev	Version 7.3.0	2019-07-31 21:11:21 +08:00
icons	Version 7.3.0	2019-07-31 21:11:21 +08:00
resources	Merge branch 'master' into snippet-panel	2019-07-26 19:10:27 +08:00
sample	add option to launch with a sample TeX file.	2019-05-05 13:09:15 +09:00
scripts	Resolve #673 Customizable docker image	2018-11-14 22:17:48 +08:00
snippets	Revert "Merge pull request #1377 from morpheusthewhite/sum_snippet"	2019-05-17 08:27:12 +02:00
src	The correct API	2019-08-01 16:05:25 +08:00
syntax	Fix #1523 syntax highlighting for \autocites	2019-07-29 15:21:38 +02:00
viewer	add a link	2019-08-01 22:43:32 +09:00
.eslintignore	use pre-commit hook by husky to lint on every commit.	2019-08-01 20:11:39 +09:00
.eslintrc.json	Disable no explicit any for now	2019-07-28 12:15:15 +02:00
.gitignore	use pre-commit hook by husky to lint on every commit.	2019-08-01 20:11:39 +09:00
.vscodeignore	use pre-commit hook by husky to lint on every commit.	2019-08-01 20:11:39 +09:00
CHANGELOG.md	Update Changelog	2019-08-01 10:18:34 +08:00
CONTRIBUTING.md	recommend eslint in CONTRIBUTING.md	2019-08-02 07:04:38 +09:00
LICENSE.txt	Compose a README	2016-12-26 16:22:34 +08:00
package-lock.json	use pre-commit hook by husky to lint on every commit.	2019-08-01 20:11:39 +09:00
package.json	use pre-commit hook by husky to lint on every commit.	2019-08-01 20:11:39 +09:00
README.md	edit README.md. add info for dev to viewer/README.md.	2019-08-01 22:38:10 +09:00
tsconfig.json	Version 7.3.0	2019-07-31 21:11:21 +08:00
yarn.lock	Bump lodash from 4.17.11 to 4.17.14	2019-07-11 06:23:22 +00:00

README.md

Visual Studio Code LaTeX Workshop Extension

$version$ $downloads$ $installs$ $rating$

$Average time to resolve an issue$ $Percentage of issues still open$

LaTeX Workshop is an extension for Visual Studio Code, aiming to provide core features for LaTeX typesetting with Visual Studio Code. It also has a sibling extension, LaTeX Utilities, providing extra features.

This project won't be successful without contributions from the community, especially the current and past key contributors:

Jerome Lelong @jlelong
Takashi Tamura @tamuratak
Tecosaur @tecosaur
James Booth @jabooth

Thank you so much!

Note that starting from version 7.0.0, LaTeX-Workshop requires at least VSCode 1.34.0.

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 snippets 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$