diff options
| author | Michael Davis | 2022-04-09 06:47:32 +0000 |
|---|---|---|
| committer | GitHub | 2022-04-09 06:47:32 +0000 |
| commit | 78b16009433041059597cc6ccea28c17254483b7 (patch) | |
| tree | 77b0994ea52c1a454ff23f918f15cfd9925925ef | |
| parent | 0b410b0a162e0c46995cad492ff1c4a65c4e5279 (diff) | |
Improve documentation on Language Server installation (#2037)
| -rw-r--r-- | README.md | 4 | ||||
| -rw-r--r-- | book/src/guides/adding_languages.md | 8 |
2 files changed, 11 insertions, 1 deletions
@@ -55,6 +55,10 @@ that sets the variable to the install dir. > NOTE: running via cargo also doesn't require setting explicit `HELIX_RUNTIME` path, it will automatically > detect the `runtime` directory in the project root. +In order to use LSP features like auto-complete, you will need to +[install the appropriate Language Server](https://github.com/helix-editor/helix/wiki/How-to-install-the-default-language-servers) +for a language. + [](https://repology.org/project/helix/versions) ## MacOS diff --git a/book/src/guides/adding_languages.md b/book/src/guides/adding_languages.md index e5fa456c..c2c70779 100644 --- a/book/src/guides/adding_languages.md +++ b/book/src/guides/adding_languages.md @@ -16,6 +16,7 @@ injection-regex = "^mylang$" file-types = ["mylang", "myl"] comment-token = "#" indent = { tab-width = 2, unit = " " } +language-server = { command = "mylang-lsp", args = ["--stdio"] } ``` These are the available keys and descriptions for the file. @@ -32,9 +33,14 @@ These are the available keys and descriptions for the file. | `diagnostic-severity` | Minimal severity of diagnostic for it to be displayed. (Allowed values: `Error`, `Warning`, `Info`, `Hint`) | | `comment-token` | The token to use as a comment-token | | `indent` | The indent to use. Has sub keys `tab-width` and `unit` | -| `config` | Language server configuration | +| `language-server` | The Language Server to run. Has sub keys `command` and `args` | +| `config` | Language Server configuration | | `grammar` | The tree-sitter grammar to use (defaults to the value of `name`) | +When adding a Language Server configuration, be sure to update the +[Language Server Wiki](https://github.com/helix-editor/helix/wiki/How-to-install-the-default-language-servers) +with installation notes. + ## Grammar configuration If a tree-sitter grammar is available for the language, add a new `grammar` |