Skip to content

LTeX: Grammar/spell checker 🔍✔️ for VS Code using LanguageTool with support for LaTeX 🎓, Markdown 📝, and others

License

Notifications You must be signed in to change notification settings

valentjn/vscode-ltex

Folders and files

NameName
Last commit message
Last commit date

Latest commit

3fdaa0b · Jul 12, 2021
May 2, 2021
Nov 22, 2020
Apr 25, 2021
Nov 1, 2020
May 24, 2020
Jul 12, 2021
Jul 11, 2021
May 1, 2021
Jun 12, 2021
Dec 4, 2020
Jan 2, 2021
Apr 5, 2021
May 26, 2020
Jun 12, 2021
May 27, 2020
Oct 12, 2020
Jul 12, 2021
Aug 15, 2020
Apr 26, 2021
Jul 8, 2020
Jul 9, 2021
Jul 12, 2021
Jul 9, 2021
Jul 9, 2021
May 26, 2020

Repository files navigation

LTEX Extension for VS Code: Grammar/Spell Checker Using LanguageTool with Support for LATEX, Markdown, and Others

latest releaseversion numberrelease date  installs  rating

vscode-ltex  CI status  stars  open issues closed issues
ltex-ls  CI status  coverage  stars  open issues closed issues

LTEX provides offline grammar checking of various markup languages in Visual Studio Code using LanguageTool (LT). LTEX currently supports BibTEX, LATEX, Markdown, Org, reStructuredText, R Sweave, and XHTML documents.

The difference to regular spell checkers is that LTEX not only detects spelling errors, but also many grammar and stylistic errors such as:

  • This is an mistake.
  • The bananas is tasty.
  • We look forward to welcome you.
  • Are human beings any different than animals?

A classic use case of LTEX is checking scientific LATEX papers in VS Code, but why not check your next blog post, book chapter, or long e-mail before you send it to someone else?

Find more information and documentation about LTEX on the official website.

LTEX is a successor (since it's a fork) of the abandoned LanguageTool for Visual Studio Code extension by Adam Voss.

Features

Grammar/Spell Checker for VS Code with LanguageTool and LaTeX Support

  • Supported markup languages: BibTEX, LATEX, Markdown, Org, reStructuredText, R Sweave, XHTML
  • Comes with everything included, no need to install Java or LanguageTool
  • Offline checking: Does not upload anything to the internet
  • Supports over 20 languages: English, French, German, Dutch, Chinese, Russian, etc.
  • Issue highlighting with hover description
  • Replacement suggestions via quick fixes
  • User dictionaries
  • Multilingual support with babel commands or magic comments
  • Possibility to use external LanguageTool servers
  • Extensive documentation

Requirements

  • 64-bit operating system
  • VS Code 1.52.0 or newer
  • Optional:
    • If you want to check documents written in a markup language that VS Code does not support out-of-the-box (e.g., LATEX), install an extension that provides support for that language (e.g., LaTeX Workshop Extension for VS Code) in addition to this extension.

How to Use

  1. Install the requirements listed above
  2. Install this extension (see download options)
  3. Reload the VS Code window if necessary
  4. Open a LATEX or a Markdown document, or open a new file and change the language mode to LaTeX or Markdown (open the Command Palette and select Change Language Mode)
  5. Wait until ltex-ls and Java have been found; if necessary, LTEX downloads both for you. Alternatively, you can choose offline installation.
  6. Grammar/spelling errors will be displayed! (if there are any)

Information & Documentation