aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/user/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/user/README.md b/docs/user/README.md
index af8a99a47..d56330192 100644
--- a/docs/user/README.md
+++ b/docs/user/README.md
@@ -92,7 +92,13 @@ to load path and require it in `init.el`
92## Vim and NeoVim 92## Vim and NeoVim
93 93
94* Install coc.nvim by following the instructions at [coc.nvim] 94* Install coc.nvim by following the instructions at [coc.nvim]
95 - You will need nodejs installed.
96 - You may want to include some of the sample vim configurations [from here][coc-vim-conf]
97 - Note that if you use a plugin manager other than `vim-plug`, you may need to manually
98 checkout the `release` branch wherever your plugin manager cloned it. Otherwise you will
99 get errors about a missing javascript file.
95* Add rust analyzer using: [coc.nvim wiki][coc-wiki] 100* Add rust analyzer using: [coc.nvim wiki][coc-wiki]
101 - Use `:CocConfig` in command mode to edit the config file.
96 102
97```jsonc 103```jsonc
98 "languageserver": { 104 "languageserver": {
@@ -101,11 +107,26 @@ to load path and require it in `init.el`
101 "filetypes": ["rust"], 107 "filetypes": ["rust"],
102 "rootPatterns": ["Cargo.toml"] 108 "rootPatterns": ["Cargo.toml"]
103 } 109 }
110 }
111```
112
113For those not familiar with js, the whole file should be enclosed in `{` and `}`, with all of your config options in between. So for example, if rust-analyzer was your only language server, you could do the following:
114
115```jsonc
116{
117 "languageserver": {
118 "rust": {
119 "command": "ra_lsp_server",
120 "filetypes": ["rust"],
121 "rootPatterns": ["Cargo.toml"]
122 }
123 }
104} 124}
105``` 125```
106 126
107[coc.nvim]: https://github.com/neoclide/coc.nvim 127[coc.nvim]: https://github.com/neoclide/coc.nvim
108[coc-wiki]: https://github.com/neoclide/coc.nvim/wiki/Language-servers#rust 128[coc-wiki]: https://github.com/neoclide/coc.nvim/wiki/Language-servers#rust
129[coc-vim-conf]: https://github.com/neoclide/coc.nvim/#example-vim-configuration
109 130
110 131
111## Sublime Text 3 132## Sublime Text 3