aboutsummaryrefslogtreecommitdiff
path: root/.config/nvim/lsp/remark_ls.lua
blob: 97541d922204fc178e35b43f86a6e3601640c6b0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
---@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',
  },
}