- Notifications
You must be signed in to change notification settings - Fork28
LTeX: Grammar/spell checker 🔍✔️ for VS Code using LanguageTool with support for LaTeX 🎓, Markdown 📝, and others
License
valentjn/vscode-ltex
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
LTEX Extension for VS Code: Grammar/Spell Checker Using LanguageTool with Support for LATEX, Markdown, and Others
LTEX provides offline grammar checking of various markup languages in Visual Studio Code usingLanguageTool (LT). LTEX currently supports BibTEX, ConTEXt, LATEX, Markdown, Org, reStructuredText, R Sweave, and XHTML documents. In addition, LTEX can check comments in many popular programming languages (optional, opt-in).
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, 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 abandonedLanguageTool for Visual Studio Code extension by Adam Voss†.
- Supported markup languages: BibTEX, ConTEXt, LATEX, Markdown, Org, reStructuredText, R Sweave, XHTML
- Comment checking inmany popular programming languages (optional, opt-in)
- Comes witheverything included, no need to install Java or LanguageTool
- Offline checking: Does not upload anything to the internet
- Supportsover 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 useexternal LanguageTool servers
- Extensive documentation
- 64-bit Linux, Mac, or Windows 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.
- Install the requirements listed above
- Install this extension (seedownload options)
- 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
LaTeX
orMarkdown
(open the Command Palette and selectChange Language Mode
) - Wait untilltex-ls has been found; if necessary, LTEX downloads it for you. Alternatively, you can chooseoffline installation.
- Grammar/spelling errors will be displayed! (if there are any)
- General Information
- Overview
- Installation & Usage
- Supported Languages
- Advanced Usage
- Settings
ltex.enabled
ltex.language
ltex.dictionary
ltex.disabledRules
ltex.enabledRules
ltex.hiddenFalsePositives
ltex.bibtex.fields
ltex.latex.commands
ltex.latex.environments
ltex.markdown.nodes
ltex.configurationTarget
ltex.additionalRules.enablePickyRules
ltex.additionalRules.motherTongue
ltex.additionalRules.languageModel
ltex.additionalRules.neuralNetworkModel
ltex.additionalRules.word2VecModel
ltex.languageToolHttpServerUri
ltex.languageToolOrg.username
ltex.languageToolOrg.apiKey
ltex.ltex-ls.path
ltex.ltex-ls.logLevel
ltex.java.path
ltex.java.initialHeapSize
ltex.java.maximumHeapSize
ltex.sentenceCacheSize
ltex.completionEnabled
ltex.diagnosticSeverity
ltex.checkFrequency
ltex.clearDiagnosticsWhenClosingFile
ltex.statusBarItem
ltex.trace.server
- FAQ
- General Questions
- What's the difference between vscode-ltex, ltex-ls, and LanguageTool?
- Why does LTEX have such a high CPU load?
- How can I check multiple languages at once?
- Why does LTEX check in a different language than expected?
- How can I fix multiple spelling errors at the same time?
- How can I prevent
\text{...}
in math mode from producing false positives? - What does LTEX stand for?
- Where can I ask a question that's not answered here?
- Questions about vscode-ltex
- General Questions
- Code of Conduct
- vscode-ltex / coc-ltex
- ltex-ls (LTEX LS)
About
LTeX: Grammar/spell checker 🔍✔️ for VS Code using LanguageTool with support for LaTeX 🎓, Markdown 📝, and others