Skip to content
Boost LaTeX typesetting efficiency with preview, compile, autocomplete, colorize, and more.
Branch: master
Clone or download
James-Yu Merge pull request #1321 from tamuratak/fix_go_back_on_viewer_2
Make go back and forward buttons on pdf viewer work with SyncTeX
Latest commit f75d2c9 Apr 20, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Update issue templates Feb 27, 2019
.vscode Update Reccomended Extensions Feb 18, 2019
data Merge pull request #1308 from tamuratak/add_readme Apr 16, 2019
demo_media Add screeenshot Dec 17, 2018
dev fix regex. Apr 14, 2019
icons Add icon for the activity bar item Sep 9, 2018
scripts Resolve #673 Customizable docker image Nov 14, 2018
snippets Fix #1302. Remove label from equation and align Apr 14, 2019
src Fix #1298. Avoid circular inclusion in the structure analyzer Apr 17, 2019
syntax #922. Use scala syntax inside scalacode environment Mar 29, 2019
viewer remove a line for debug Apr 20, 2019
.gitignore added into .gitignore for python dev Apr 14, 2019
.vscodeignore Use https to show gifs in readme Nov 3, 2018
CHANGELOG.md Wrong date Apr 11, 2019
CONTRIBUTING.md Add contributing.md Apr 16, 2019
LICENSE.txt Compose a README Dec 26, 2016
README.md Fix #1270. Update wiki TOC Apr 2, 2019
SHORTCUT.md Update shortcut description Nov 14, 2018
_config.yml Set theme jekyll-theme-minimal Nov 23, 2018
icon.png Version 6.0.0 Feb 19, 2019
minify.sh #941 Should work now Nov 3, 2018
package.json Version 6.4.0 Apr 11, 2019
tsconfig.json get all text surrounding the selection and incrementally find best match Feb 10, 2019
tslint.json exclude src/lib/await-semaphore to tslint Feb 19, 2019
webpack.config.js Nice to have webpack back Oct 17, 2018
yarn.lock Remove codes related to `latex.additionalBib` and `intellisense.surro… Feb 19, 2019

README.md

Visual Studio Code LaTeX Workshop Extension

version downloads installs rating license

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.

    error reporting demo
    • Linting
    auto \item demo
  • 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.

        greek letters demo
      • 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.

        BSAL demo
      • 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.

        FBF demo
      • 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

GitHub

The code for this extension is available on github at: https://github.com/James-Yu/LaTeX-Workshop

Like this work?

License

MIT

You can’t perform that action at this time.