The installation of LTEX+ depends on the scenario in which you want to use LTEX+. LTEX+ can be used
- as an extension for your editor,
- as a language client using the Language Server Protocol (LSP), or
- standalone on the command line.
Choose the topmost scenario that applies to you.
Via Editor Extensions
LTEX+ publishes official extensions for Visual Studio Code (VS Code). For some other popular editors, third-party extensions exist that add support for LTEX+. If no extension exists yet for your editor, but your editor supports the Language Server Protocol (LSP), then you should be able to use LTEX+ as a language client.
Official Extensions
| Editor | Extension | Link to instructions |
|---|---|---|
| VS Code | vscode-ltex-plus | Instructions |
Third-Party Extensions
LTEX+ is not responsible for the quality of third-party extensions. The list and corresponding links are provided for your information only.
| Editor | Extension | Link to instructions |
|---|---|---|
| Emacs + eglot | eglot-ltex | Instructions |
| Emacs + lsp-mode | lsp-ltex | Instructions |
| Neovim | Grammar Guard | Instructions |
| Neovim | nvim-lsp-installer | Instructions |
| Neovim + nvim-lspconfig | lbiaggi/ltex.lua | Instructions |
| Neovim + nvim-lspconfig | LTEX_extra.nvim | Instructions |
| Sublime Text | LSP-ltex-ls-plus | Instructions |
Via Language Clients
If your editor is not yet supported by an extension, but it supports the Language Server Protocol (LSP), then you can use the language server LTEX+ LS (read here for instructions).
Typically, the editor starts LTEX+ LS during startup (either locally or remotely), it sends LTEX+ LS your LATEX or Markdown document, and LTEX+ LS will respond with a list of the grammar and spelling errors in it. The communication between server and editor is done using the LSP, with a language client as a communication endpoint that runs in the editor.
If your editor already supports the LSP (either natively or via an extension), then writing a language client for LTEX+ should be possible with almost no overhead. If your editor doesn’t support the LSP, then you can write a language client yourself that communicates with LTEX+ LS according to the LSP specification.
Via Command Line
LTEX+ can be run on the command line. In this mode, you supply LTEX paths to files and directories to be checked as command-line arguments. The results will be printed to the standard output, and no language client or knowledge of the Language Server Protocol (LSP) is necessary.
The command-line interface (CLI) of LTEX+ is included in LTEX+ LS. Read here for instructions.