coc-ltex
v13.1.0
Published
Grammar/spell checker using LanguageTool with support for LaTeX, Markdown, and others
Downloads
221
Readme
LTEX Extension for coc.nvim: Grammar/Spell Checker Using LanguageTool with Support for LATEX, Markdown, and Others
LTEX provides offline grammar checking of various markup languages in Vim/Neovim using LanguageTool (LT) and coc.nvim. 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 abandoned LanguageTool for Visual Studio Code extension by Adam Voss†.
Features
- Supported markup languages: BibTEX, ConTEXt, LATEX, Markdown, Org, reStructuredText, R Sweave, XHTML
- Comment checking in many popular programming languages (optional, opt-in)
- 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 Linux, Mac, or Windows operating system
- Node.js 14.16.0 or later
- Vim or Neovim with coc.nvim 0.0.80 or newer
How to Use
- Install the requirements listed above
- Install coc-ltex by running
:CocInstall coc-ltex
- If you want to check LaTeX documents: Add
let g:coc_filetype_map = {'tex': 'latex'}
to~/.vimrc
(Vim) or~/.config/nvim/init.vim
(workaround for #425, until neoclide/coc.nvim#3433 is released) - Open a LaTeX or a Markdown document
- Wait until ltex-ls has been downloaded and started
- Grammar/spelling errors will be displayed! (if there are any)
Information & Documentation
- 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)