James-Yu/LaTeX-Workshop
1
1
Fork 0
mirror of https://github.com/James-Yu/LaTeX-Workshop.git synced 2024-10-04 15:17:59 +03:00
Code Issues Projects Releases Wiki Activity
Boost LaTeX typesetting efficiency with preview, compile, autocomplete, colorize, and more.
90 Commits 2 Branches 285 Tags 71 MiB
TypeScript 60.4%
JavaScript 25%
CSS 7.9%
HTML 3.3%
Python 3.2%
Other 0.2%
c0a36161e7
Go to file
James Booth c0a36161e7 Report Latex Log errors as diagnostics per file
2017-03-24 13:43:22 +00:00
.vscode Changes in code for parser movement 2017-01-26 14:27:38 +08:00
data Remove quote autoclosing 2017-02-16 13:19:43 +08:00
img (#28) Change title bar icons c.r. @bartosz-antosik 2017-03-16 13:06:05 +08:00
lib Add new error handle, more formatting 2017-01-26 14:45:39 +08:00
pdfjs #8 merge proposed fixes 2017-01-27 14:31:22 +08:00
src Report Latex Log errors as diagnostics per file 2017-03-24 13:43:22 +00:00
.gitignore Update gitignore 2017-01-19 11:04:34 +08:00
.gitmodules Move bibtex parser to lib folder 2017-01-26 14:27:15 +08:00
.vscodeignore Initial commit 2016-12-26 16:05:30 +08:00
CHANGELOG.md (#29) Status bar item changes 2017-03-19 12:45:15 +08:00
LICENSE.txt Compose a README 2016-12-26 16:22:34 +08:00
package.json Version bump 2017-03-19 12:48:17 +08:00
README.md (#18) Compile from active editor command. 2017-02-28 14:38:44 +08:00
THIRDPARTY.txt Some version update work 2017-01-19 12:12:37 +08:00
tsconfig.json Initial commit 2016-12-26 16:05:30 +08:00

README.md

Visual Studio Code LaTeX Workshop Extension

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.

Features

  • Compile LaTeX with BibTeX to PDF
  • Preview PDF on-the-fly (in VSCode or browser)
  • Support direct and reverse SyncTex
  • Autocomplete
  • Colorize
  • Log parser

Requirements

  • LaTeX distribution in system PATH. For example, TeX Live.

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).

Alternatively, you can check out this repository and copy it to the VS Code local extensions folder:

  • Windows %USERPROFILE%\.vscode\extensions
  • Mac/Linux $HOME/.vscode/extensions

Usage

  • Compile: Either use latex-workshop.compile command, or use right click menu, or simply enable compile-on-save.
  • Preview: Click on the Show Preview button on the top-right corner of the editor. The preview is updated automatically after compilation.
  • In-browser Preview: Right click on TeX and select Show In-browser Preview.
  • Direct SyncTex from Tex to PDF: Open preview first then right click on TeX and select Find in Preview.
  • Reverse SyncTex from PDF to TeX: ctrl/cmd + left click on PDF preview.
  • Autocomplete: An autocomplete list will show up when '' or '{' is typed. Multi-citation supported.

Commands

  • latex-workshop.compile: Compile LaTeX to PDF.
  • latex-workshop.compile_here: Compile LaTeX to PDF from active editor.
  • latex-workshop.preview: Open a live preview column for LaTeX.
  • latex-workshop.preview_browser: Open a webpage preview for LaTeX.
  • latex-workshop.source: Show LaTeX source of the preview.
  • latex-workshop.synctex: Direct synctex from cursor position.

Settings

All settings need VS Code reload to take effect.

  • latex-workshop.compiler: Set the LaTeX compiler command.
  • latex-workshop.compile_argument: Set the compiler arguments. It is required that non-blocking compile argument is used, e.g., -halt-on-error and -interaction=nonstopmode.
  • latex-workshop.compile_workflow: Set the compile workflow of LaTeX. Default is latex->bibtex->latex->latex. An array of commands is required here. Each command will be executed when the previous one is finished. If any command outputs error, the workflow will terminate. Some placeholders are available:
    • %compiler%: The compiler set in latex-workshop.compiler.
    • %arguments%: The compiler argument set in latex-workshop.compile_argument.
    • %document%: Name of the current active file in VS Code.
  • latex-workshop.compile_on_save: Whether LaTeX Workshop should compile the current active LaTeX file on save.
  • latex-workshop.main_document: The relative path to the main document for LaTeX project. Auto-detection enabled with null.
  • latex-workshop.log_level: Define the LaTeX log parser output level. Available levels: all for all log entries, warning for warnings and errors, error for errors only.

Contributing

  • Fork it.
  • Do something.
  • Pull request.
  • Thank you and have some beer.

License

MIT