- Download from within VS Code: Open the Extensions panel and type
- Visual Studio Marketplace (VS Code uses this for downloading)
- Open VSX
- Releases on GitHub (+ packages for offline installation)
- Source on GitHub
- 64-bit Linux, Mac, or Windows operating system
- VS Code 1.52.0 or later (new versions of LTEX released on or after January 14, 2022, will require VS Code 1.61.0 or later)
- If you want to check LATEX documents: LaTeX Workshop Extension for VS Code
- If you want to check Org documents: Org Mode Extension for VS Code
- If you want to check reStructuredText documents: reStructuredText Extension for VS Code
How to Install and Use
- Install the requirements listed above
- Install this extension
- Reload the VS Code window if necessary
- Open a LATEX or a Markdown document, or open a new file and change the language mode to
Markdown(open the Command Palette and select
Change Language Mode)
- Wait until ltex-ls has been found; if necessary, LTEX downloads it for you. Alternatively, you can choose offline installation.
- Grammar/spelling errors will be displayed! (if there are any)
The key component of LTEX, the LTEX Language Server (ltex-ls), which also includes Java and LanguageTool, cannot be included in the LTEX version distributed on the Visual Studio Marketplace due to file size restrictions.
When activated for the first time, LTEX will automatically download and use a hard-coded ltex-ls release from GitHub. It will be stored in the extension folder. Note that after this initial installation, no connection to the Internet is necessary. Checking your documents is completely offline.
If you don’t have an Internet connection, or if you simply don’t want this, there are two alternatives.
In case there are any problems, you will find additional debug info in
LTeX Language Server and
LTeX Language Client.
First Alternative: Download the Offline Version of LTEX
Download the offline version of LTEX at the Releases page on GitHub and install it via
Extensions: Install from VSIX... on the Command Palette. The offline version already includes ltex-ls (and the portable Java distribution). Reload the Visual Studio Code window after installing the offline version.
Second Alternative: Download ltex-ls/Java Manually
Download ltex-ls and/or a Java distribution (e.g., Eclipse Adoptium) individually and set
ltex.java.path to the respective locations. If you download a binary release of ltex-ls (those include a platform in the archive file name), then that release already includes Java and you don’t need to set
Note that the versions of ltex-ls and/or Java have to satisfy the following requirements:
Each version of LTEX has been tested with exactly one version of ltex-ls, which is the version that LTEX automatically downloads. If you download ltex-ls manually, be sure to use this version of ltex-ls. An older or a newer version of ltex-ls might work, or it might not.
For this reason, this approach is not recommended as automatically updated versions of LTEX (by Visual Studio Code) might not be compatible anymore with your manually downloaded version of ltex-ls. If you choose this approach, remember to update ltex-ls if LTEX doesn’t work anymore.
To find out which version a particular version of LTEX uses, check the changelog for
Update LTEX LS to X.Y.Z. If there is no entry of this form in the changelog for the version of LTEX you want to use, use the entry of the first previous version of LTEX that has such an entry.
The version of Java must be at least 11. Some Java distributions offer a JRE (Java Runtime Environment) and a JDK (Java Development Kit); in this case, the JRE is sufficient.
If you download Java, you can also decide to install it system-wide. In this case, LTEX should be able to automatically detect its location. If not, you can still set
ltex.java.path to the location of your system-wide installation.
Reload the Visual Studio Code window after installing ltex-ls and/or Java.