Skip to content

Install

tecosaur edited this page Jan 26, 2019 · 6 revisions

Installation and basic settings

Requirements

Installation

Installing LaTeX Workshop is simple. You can find it in Visual Studio Code Marketplace, or simply run ext install latex-workshop in VS Code Quick Open (ctrl/cmd + P).

Usage

The typical usage is to open a .tex file and have a look at the TeX sidebar to access all the extension features

  • Building
  • Viewing and going from source to PDF back and forth
  • Catching errors and warnings
  • Navigating in environments
  • Navigating the document structure. The section names of LaTeX outline hierarchy are defined in latex-workshop.view.outline.sections. This property is an array of case-sensitive strings in the order of document structure hierarchy. For multiple tags in the same level, separate the tags with | as delimiters, e.g., section|alternative. It is also used by the folding mechanism.
  • Miscellaneous actions
    • Open citation browser, see also Intellisense for citations
    • Count words the .tex file. It uses the texcount utility. Use latex-workshop.texcount.path to set the path to the texcount executable and latex-workshop.texcount.args to supply extra arguments.

If you prefer to access some all the most common actions through a right click menu, set latex-workshop.showContextMenu to true. Default is false.

Using Docker

Starting with release 5.3.0, there is an experimental implementation on Docker support following the idea of @Arxisos. You can set latex-workshop.docker.enabled to true to use tianon/latex. It is advised that the image is 'pre-'pulled.

@Arxisos created snippets for LaTeX binaries in docker, and @lippertmarkus had another short description on how to use Docker with LaTeX Workshop.

You can’t perform that action at this time.