James-Yu/LaTeX-Workshop
1
1
Fork 0
mirror of https://github.com/James-Yu/LaTeX-Workshop.git synced 2024-10-04 23:27:20 +03:00
Code Issues Projects Releases Wiki Activity
Boost LaTeX typesetting efficiency with preview, compile, autocomplete, colorize, and more.
16 Commits 2 Branches 285 Tags 71 MiB
TypeScript 60.4%
JavaScript 25%
CSS 7.9%
HTML 3.3%
Python 3.2%
Other 0.2%
9fe742b59c
Go to file
James-Yu 9fe742b59c Direct synctex. May be not accuracy but working
2016-12-28 14:59:46 +08:00
.vscode Initial commit 2016-12-26 16:05:30 +08:00
pdfjs Direct synctex. May be not accuracy but working 2016-12-28 14:59:46 +08:00
src Direct synctex. May be not accuracy but working 2016-12-28 14:59:46 +08:00
.gitignore Initial commit 2016-12-26 16:05:30 +08:00
.vscodeignore Initial commit 2016-12-26 16:05:30 +08:00
CHANGELOG.md Direct synctex. May be not accuracy but working 2016-12-28 14:59:46 +08:00
LICENSE.txt Compose a README 2016-12-26 16:22:34 +08:00
package.json Direct synctex. May be not accuracy but working 2016-12-28 14:59:46 +08:00
README.md Direct synctex. May be not accuracy but working 2016-12-28 14:59:46 +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 to PDF
  • Compile BibTeX
  • Preview PDF on-the-fly
  • Support direct and reverse SyncTex
  • Autocomplete

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 simply save the TeX source file.
  • Preview: Click on the Preview PDF button on the top-right corner of the editor. The preview is updated automatically after compilation.
  • Direct SyncTex from Tex to PDF: Open preview first then right click on TeX and select Show in Preview.
  • Reverse SyncTex from PDF to TeX: ctrl/cmd + left click on PDF preview.

Commands

  • latex-workshop.compile: Compile LaTeX to PDF.
  • latex-workshop.preview: Open a live preview column for LaTeX.
  • latex-workshop.source: Show LaTeX source of the preview.

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.

Contributing

Fork it and thank you!

License

MIT