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 aa44c4f7b0 Edit JSDoc.		2020-07-08 17:22:56 +09:00
.devcontainer	make docker image smaller	2019-05-08 07:35:33 +09:00
.github	Ask users whether they are using VSCodium.	2020-06-29 16:18:16 +09:00
.vscode	Add integration tests of building TeX files.	2020-03-04 20:56:34 +09:00
data	Update .json files	2020-06-02 11:37:41 +02:00
demo_media	Add more demo media	2020-04-28 14:14:20 +02:00
dev	Turn (...) into snippets	2020-06-02 11:31:32 +02:00
icons	Icon by @trevorgunn	2019-11-04 23:03:12 +08:00
resources	Use WebView.asWebviewUri and WebView.cspSource. Close #2091 .	2020-05-17 08:49:32 +09:00
sample	add option to launch with a sample TeX file.	2019-05-05 13:09:15 +09:00
scripts	Do not echo commands in .bat scripts	2019-12-28 22:09:31 +01:00
snippets	Add tikzpicture environment snippet	2019-09-29 00:59:07 +08:00
src	Edit JSDoc.	2020-07-08 17:22:56 +09:00
syntax	Fix #2176 . No need to put the closing } on its own line in .bib	2020-06-26 21:12:58 +02:00
test	Edit JSDoc.	2020-07-08 17:22:56 +09:00
types	use workerpool for MathPreview. Related to #1788	2019-11-12 08:17:16 +09:00
viewer	Add invert PDF in dark mode only. (#2158 )	2020-07-04 08:54:34 +09:00
.eslintignore	add files	2019-10-19 21:40:26 +09:00
.eslintrc.json	Remove comments.	2020-06-09 07:36:38 +09:00
.gitignore	Add tests of auto build.	2020-03-07 16:18:15 +09:00
.vscodeignore	* Add node_modules/pdfjs-dist/es5/ and node_modules/pdfjs-dist/image_decoders/ to .vscodeignore. It is not used in the PDF.js viewer.	2020-06-13 09:27:31 +09:00
CHANGELOG.md	Fix #2180 Version 8.11.1	2020-07-01 08:43:51 +08:00
CONTRIBUTING.md	Use the JSDoc format. Add badges to READEME.md.	2020-03-28 07:41:58 +09:00
LICENSE.txt	Compose a README	2016-12-26 16:22:34 +08:00
package-lock.json	Update package-lock.json	2020-07-01 20:50:04 +09:00
package.json	We should keep using "latex-workshop.view.pdf.invert" for backward compatibility.	2020-07-06 08:10:00 +09:00
README.md	Edit links to wiki/View	2020-06-25 18:44:30 +09:00
tsconfig.eslint.json	Add integration tests of building TeX files.	2020-03-04 20:56:34 +09:00
tsconfig.eslint.viewer.json	Add integration tests of building TeX files.	2020-03-04 20:56:34 +09:00
tsconfig.json	enable esModuleInterop in tsconfig.json, which is necessary to compile with the jimp package.	2020-05-02 19:22:34 +09:00

README.md

Visual Studio Code LaTeX Workshop Extension

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

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

$TeX Live on Windows$ $TeX Live on macOS$ $TeX Live on Linux$ $Docker 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 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.38.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$