diff options
| author | github-actions <github-actions@github.com> | 2021-12-24 18:23:00 +0000 |
|---|---|---|
| committer | github-actions <github-actions@github.com> | 2021-12-24 18:23:00 +0000 |
| commit | 2b2ff8f860a9834643d257df64e32b8dabb948cc (patch) | |
| tree | 87a59d3782f4920eb97615eecc00d6a00ef1f231 /doc | |
| parent | feat(remark): add remark-language-server (#1606) (diff) | |
| download | nvim-lspconfig-2b2ff8f860a9834643d257df64e32b8dabb948cc.tar nvim-lspconfig-2b2ff8f860a9834643d257df64e32b8dabb948cc.tar.gz nvim-lspconfig-2b2ff8f860a9834643d257df64e32b8dabb948cc.tar.bz2 nvim-lspconfig-2b2ff8f860a9834643d257df64e32b8dabb948cc.tar.lz nvim-lspconfig-2b2ff8f860a9834643d257df64e32b8dabb948cc.tar.xz nvim-lspconfig-2b2ff8f860a9834643d257df64e32b8dabb948cc.tar.zst nvim-lspconfig-2b2ff8f860a9834643d257df64e32b8dabb948cc.zip | |
docs: update server_configurations.md
skip-checks: true
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/server_configurations.md | 58 | ||||
| -rw-r--r-- | doc/server_configurations.txt | 58 |
2 files changed, 116 insertions, 0 deletions
diff --git a/doc/server_configurations.md b/doc/server_configurations.md index 8195d34f..519f073b 100644 --- a/doc/server_configurations.md +++ b/doc/server_configurations.md @@ -88,6 +88,7 @@ that config. This file is accessible in neovim via `:help lspconfig-server-confi - [quick_lint_js](#quick_lint_js) - [r_language_server](#r_language_server) - [racket_langserver](#racket_langserver) +- [remark_ls](#remark_ls) - [rescriptls](#rescriptls) - [rls](#rls) - [rnix](#rnix) @@ -5541,6 +5542,63 @@ require'lspconfig'.racket_langserver.setup{} ``` +## remark_ls + +https://github.com/remarkjs/remark-language-server + +`remark-language-server` can be installed via `npm`: +```sh +npm install -g remark-language-server +``` + +`remark-language-server` uses the same +[configuration files](https://github.com/remarkjs/remark/tree/main/packages/remark-cli#example-config-files-json-yaml-js) +as `remark-cli`. + +This uses a plugin based system. Each plugin needs to be installed locally using `npm` or `yarn`. + +For example, given the following `.remarkrc.json`: + +```json +{ + "presets": [ + "remark-preset-lint-recommended" + ] +} +``` + +`remark-preset-lint-recommended` needs to be installed in the local project: + +```sh +npm install remark-preset-lint-recommended +``` + + + + +**Snippet to enable the language server:** +```lua +require'lspconfig'.remark_ls.setup{} +``` + +**Commands and default values:** +```lua + Commands: + + Default Values: + cmd = { "remark-language-server", "--stdio" } + filetypes = { "markdown" } + root_dir = function(path) + -- Support git directories and git files (worktrees) + if M.path.is_dir(M.path.join(path, '.git')) or M.path.is_file(M.path.join(path, '.git')) then + return path + end + end) + end + single_file_support = true +``` + + ## rescriptls https://github.com/rescript-lang/rescript-vscode diff --git a/doc/server_configurations.txt b/doc/server_configurations.txt index 8195d34f..519f073b 100644 --- a/doc/server_configurations.txt +++ b/doc/server_configurations.txt @@ -88,6 +88,7 @@ that config. This file is accessible in neovim via `:help lspconfig-server-confi - [quick_lint_js](#quick_lint_js) - [r_language_server](#r_language_server) - [racket_langserver](#racket_langserver) +- [remark_ls](#remark_ls) - [rescriptls](#rescriptls) - [rls](#rls) - [rnix](#rnix) @@ -5541,6 +5542,63 @@ require'lspconfig'.racket_langserver.setup{} ``` +## remark_ls + +https://github.com/remarkjs/remark-language-server + +`remark-language-server` can be installed via `npm`: +```sh +npm install -g remark-language-server +``` + +`remark-language-server` uses the same +[configuration files](https://github.com/remarkjs/remark/tree/main/packages/remark-cli#example-config-files-json-yaml-js) +as `remark-cli`. + +This uses a plugin based system. Each plugin needs to be installed locally using `npm` or `yarn`. + +For example, given the following `.remarkrc.json`: + +```json +{ + "presets": [ + "remark-preset-lint-recommended" + ] +} +``` + +`remark-preset-lint-recommended` needs to be installed in the local project: + +```sh +npm install remark-preset-lint-recommended +``` + + + + +**Snippet to enable the language server:** +```lua +require'lspconfig'.remark_ls.setup{} +``` + +**Commands and default values:** +```lua + Commands: + + Default Values: + cmd = { "remark-language-server", "--stdio" } + filetypes = { "markdown" } + root_dir = function(path) + -- Support git directories and git files (worktrees) + if M.path.is_dir(M.path.join(path, '.git')) or M.path.is_file(M.path.join(path, '.git')) then + return path + end + end) + end + single_file_support = true +``` + + ## rescriptls https://github.com/rescript-lang/rescript-vscode |
