docs(wiki): setup instruction for lsp

saecki · Jan 15, 2024 · 73e1fb3 · 73e1fb3
1 parent e46ef1e
commit 73e1fb3
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 0 deletions.
diff --git a/docgen/templates/documentation.md.in b/docgen/templates/documentation.md.in
@@ -2,6 +2,7 @@ Documentation for `crates.nvim` `<VERSION>`
 
 # Features
 - Complete crate versions and features
+- In-process language server
 - Completion sources for:
     - [nvim-cmp](https://github.com/hrsh7th/nvim-cmp)
     - [coq.nvim](https://github.com/ms-jpq/coq_nvim)
@@ -27,6 +28,24 @@ Documentation for `crates.nvim` `<VERSION>`
     - Indicate if a dependency is optional
 
 # Setup
+
+## lsp
+Enable the in-process language server in the setup and select whether to enable
+code actions and auto completion.
+```lua
+require("crates").setup {
+    ...
+    lsp = {
+        enabled = true,
+        on_attach = function(client, bufnr)
+            -- the same on_attach function as for your other lsp's
+        end,
+        actions = true,
+        completion = true,
+    },
+}
+```
+
 ## Auto completion
 ### [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) source
 

diff --git a/docgen/wiki/Unstable-documentation.md b/docgen/wiki/Unstable-documentation.md
@@ -2,6 +2,7 @@ Documentation for `crates.nvim` `unstable`
 
 # Features
 - Complete crate versions and features
+- In-process language server
 - Completion sources for:
     - [nvim-cmp](https://github.com/hrsh7th/nvim-cmp)
     - [coq.nvim](https://github.com/ms-jpq/coq_nvim)
@@ -27,6 +28,24 @@ Documentation for `crates.nvim` `unstable`
     - Indicate if a dependency is optional
 
 # Setup
+
+## lsp
+Enable the in-process language server in the setup and select whether to enable
+code actions and auto completion.
+```lua
+require("crates").setup {
+    ...
+    lsp = {
+        enabled = true,
+        on_attach = function(client, bufnr)
+            -- the same on_attach function as for your other lsp's
+        end,
+        actions = true,
+        completion = true,
+    },
+}
+```
+
 ## Auto completion
 ### [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) source