nvim-lspconfig/lsp/remark_ls.lua

47 lines
1.1 KiB
Lua

---@brief
---
--- 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
--- ```
---@type vim.lsp.Config
return {
cmd = { 'remark-language-server', '--stdio' },
filetypes = { 'markdown' },
root_markers = {
'.remarkrc',
'.remarkrc.json',
'.remarkrc.js',
'.remarkrc.cjs',
'.remarkrc.mjs',
'.remarkrc.yml',
'.remarkrc.yaml',
'.remarkignore',
},
}