diff options
| -rw-r--r-- | book/src/guides/adding_languages.md | 8 | ||||
| -rw-r--r-- | book/src/lang-support.md | 16 | ||||
| -rw-r--r-- | languages.toml | 3 |
3 files changed, 20 insertions, 7 deletions
diff --git a/book/src/guides/adding_languages.md b/book/src/guides/adding_languages.md index c2c70779..e9e1a69f 100644 --- a/book/src/guides/adding_languages.md +++ b/book/src/guides/adding_languages.md @@ -37,9 +37,11 @@ These are the available keys and descriptions for the file. | `config` | Language Server configuration | | `grammar` | The tree-sitter grammar to use (defaults to the value of `name`) | +When adding a new language or Language Server configuration for an existing +language, run `cargo xtask docgen` to add the new configuration to the +[Language Support][lang-support] docs before creating a pull request. 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. +[Language Server Wiki][install-lsp-wiki] with installation notes. ## Grammar configuration @@ -94,3 +96,5 @@ the last matching query supersedes the ones before it. See [treesitter-language-injection]: https://tree-sitter.github.io/tree-sitter/syntax-highlighting#language-injection [languages.toml]: https://github.com/helix-editor/helix/blob/master/languages.toml [neovim-query-precedence]: https://github.com/helix-editor/helix/pull/1170#issuecomment-997294090 +[install-lsp-wiki]: https://github.com/helix-editor/helix/wiki/How-to-install-the-default-language-servers +[lang-support]: ../lang-support.md diff --git a/book/src/lang-support.md b/book/src/lang-support.md index 3920f342..6a08cd69 100644 --- a/book/src/lang-support.md +++ b/book/src/lang-support.md @@ -1,10 +1,16 @@ # Language Support -For more information like arguments passed to default LSP server, -extensions assosciated with a filetype, custom LSP settings, filetype -specific indent settings, etc see the default -[`languages.toml`][languages.toml] file. +The following languages and Language Servers are supported. In order to use +Language Server features, you must first [install][lsp-install-wiki] the +appropriate Language Server. + +Check the language support in your installed helix version with `hx --health`. + +Also see the [Language Configuration][lang-config] docs and the [Adding +Languages][adding-languages] guide for more language configuration information. {{#include ./generated/lang-support.md}} -[languages.toml]: https://github.com/helix-editor/helix/blob/master/languages.toml +[lsp-install-wiki]: https://github.com/helix-editor/helix/wiki/How-to-install-the-default-language-servers +[lang-config]: ./languages.md +[adding-languages]: ./guides/adding_languages.md diff --git a/languages.toml b/languages.toml index 13c34e01..b382b013 100644 --- a/languages.toml +++ b/languages.toml @@ -1,3 +1,6 @@ +# Language support configuration. +# See the languages documentation: https://docs.helix-editor.com/master/languages.html + [[language]] name = "rust" scope = "source.rust" |