git.iko.soy/helix
on master help sign in
Rewrite Language Support docs (#2065)
commit3d79c60a1ff7d2976c89b90976746df629be34fa authorMichael Davis <mcarsondavis@gmail.com> dateSun 10 Apr 2022, 12:50 (5 years ago) parent562874a
3 files changed+20−7
compare with master
unifiedsplit
book/src/guides/adding_languages.md+6−2 book/src/lang-support.md+11−5 languages.toml+3
book/src/guides/adding_languages.md+6−2
@@ -37,9 +37,11 @@ These are the available keys and descriptions for the file.
3737| `config` | Language Server configuration |
3838| `grammar` | The tree-sitter grammar to use (defaults to the value of `name`) |
3939
40+When adding a new language or Language Server configuration for an existing
41+language, run `cargo xtask docgen` to add the new configuration to the
42+[Language Support][lang-support] docs before creating a pull request.
4043When adding a Language Server configuration, be sure to update the
41−[Language Server Wiki](https://github.com/helix-editor/helix/wiki/How-to-install-the-default-language-servers)
42−with installation notes.
44+[Language Server Wiki][install-lsp-wiki] with installation notes.
4345
4446## Grammar configuration
4547
@@ -94,3 +96,5 @@ the last matching query supersedes the ones before it. See
9496[treesitter-language-injection]: https://tree-sitter.github.io/tree-sitter/syntax-highlighting#language-injection
9597[languages.toml]: https://github.com/helix-editor/helix/blob/master/languages.toml
9698[neovim-query-precedence]: https://github.com/helix-editor/helix/pull/1170#issuecomment-997294090
99+[install-lsp-wiki]: https://github.com/helix-editor/helix/wiki/How-to-install-the-default-language-servers
100+[lang-support]: ../lang-support.md
book/src/lang-support.md+11−5
@@ -1,10 +1,16 @@
11# Language Support
22
3−For more information like arguments passed to default LSP server,
4−extensions assosciated with a filetype, custom LSP settings, filetype
5−specific indent settings, etc see the default
6−[`languages.toml`][languages.toml] file.
3+The following languages and Language Servers are supported. In order to use
4+Language Server features, you must first [install][lsp-install-wiki] the
5+appropriate Language Server.
6+
7+Check the language support in your installed helix version with `hx --health`.
8+
9+Also see the [Language Configuration][lang-config] docs and the [Adding
10+Languages][adding-languages] guide for more language configuration information.
711
812{{#include ./generated/lang-support.md}}
913
10−[languages.toml]: https://github.com/helix-editor/helix/blob/master/languages.toml
14+[lsp-install-wiki]: https://github.com/helix-editor/helix/wiki/How-to-install-the-default-language-servers
15+[lang-config]: ./languages.md
16+[adding-languages]: ./guides/adding_languages.md
languages.toml+3
@@ -1,3 +1,6 @@
1+# Language support configuration.
2+# See the languages documentation: https://docs.helix-editor.com/master/languages.html
3+
14[[language]]
25name = "rust"
36scope = "source.rust"