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

Jerome Lelong a37afced76 Revert "Merge pull request #1377 from morpheusthewhite/sum_snippet" This reverts commit `474189a2db`, reversing changes made to `3db02e51e3`. See discussion in #1377.		2019-05-17 08:27:12 +02:00
.devcontainer	make docker image smaller	2019-05-08 07:35:33 +09:00
.github/ISSUE_TEMPLATE	edit issue template	2019-05-08 12:21:46 +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	Add screeenshot	2018-12-17 16:47:57 +01:00
dev	fix regex.	2019-04-14 12:27:38 +09:00
icons	Add icon for the activity bar item	2018-09-09 16:14:46 +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	Merge pull request #1357 from tamuratak/enable_remote_dev	2019-05-17 10:03:57 +08:00
syntax	Update syntax.json	2019-04-22 14:17:51 +08:00
viewer	add null check	2019-05-11 09:10:08 +09:00
_config.yml	Set theme jekyll-theme-minimal	2018-11-23 10:41:11 +08:00
.gitignore	added into .gitignore for python dev	2019-04-15 08:01:44 +09:00
.vscodeignore	Use https to show gifs in readme	2018-11-03 18:43:45 +08:00
CHANGELOG.md	Version 7.0.0	2019-05-17 10:35:55 +08:00
CONTRIBUTING.md	Add contributing.md	2019-04-16 10:37:06 -04:00
icon.png	Version 6.0.0	2019-02-19 09:54:13 +08:00
LICENSE.txt	Compose a README	2016-12-26 16:22:34 +08:00
minify.sh	#941 Should work now	2018-11-03 20:44:34 +08:00
package.json	Version 7.0.0	2019-05-17 10:35:55 +08:00
README.md	Fix #1270 . Update wiki TOC	2019-04-02 16:53:46 +02:00
SHORTCUT.md	Update shortcut description	2018-11-15 00:13:54 +08:00
tsconfig.json	get all text surrounding the selection and incrementally find best match	2019-02-10 23:11:11 +01:00
tslint.json	exclude src/lib/await-semaphore to tslint	2019-02-19 12:32:28 +09:00
webpack.config.js	Nice to have webpack back	2018-10-17 10:31:22 +08:00
yarn.lock	Version 7.0.0	2019-05-17 10:35:55 +08: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 all-in-one features and utilities for LaTeX typesetting with Visual Studio Code.

This project won't be successful without contributions from the community, especially project maintainers Jerome Lelong @jlelong, James Booth @jabooth, and all code contributors! Thank you!

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.
$auto \item demo$