summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWilliam Boman <william@redwill.se>2022-07-24 23:49:55 +0200
committerGitHub <noreply@github.com>2022-07-24 21:49:55 +0000
commit84aff881ee525288297a381c6e5998ffddaa43ed (patch)
tree2fd7bf67241c778b29da2d42b83a47fea373ea93
parentdocs: remove alpha branch from mason.nvim (#4) (diff)
downloadmason-lspconfig-84aff881ee525288297a381c6e5998ffddaa43ed.tar
mason-lspconfig-84aff881ee525288297a381c6e5998ffddaa43ed.tar.gz
mason-lspconfig-84aff881ee525288297a381c6e5998ffddaa43ed.tar.bz2
mason-lspconfig-84aff881ee525288297a381c6e5998ffddaa43ed.tar.lz
mason-lspconfig-84aff881ee525288297a381c6e5998ffddaa43ed.tar.xz
mason-lspconfig-84aff881ee525288297a381c6e5998ffddaa43ed.tar.zst
mason-lspconfig-84aff881ee525288297a381c6e5998ffddaa43ed.zip
docs: extend quickstart section (#5)
-rw-r--r--doc/mason-lspconfig.txt25
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/mason-lspconfig.txt b/doc/mason-lspconfig.txt
index 20392b3..3d71093 100644
--- a/doc/mason-lspconfig.txt
+++ b/doc/mason-lspconfig.txt
@@ -41,6 +41,31 @@ to call the `setup()` function:
require("mason").setup()
require("mason-lspconfig").setup()
+Next, you're ready to set up the servers you want to use! Refer to lspconfig's
+documentation |lspconfig-quickstart| for more information on how to do so!
+
+ require("lspconfig").sumneko_lua.setup {}
+ require("lspconfig").rust_analyzer.setup {}
+
+Refer to |mason-lspconfig.setup_handlers()| (advanced feature) for an
+alternative method of setting up servers that don't require you to do so
+imperatively for each server.
+
+To install an LSP server supported by lspconfig (and mason.nvim) you may use
+the `:LspInstall` command, like so:
+
+ :LspInstall rust_analyzer sumneko_lua
+
+This command is more or less an alias of the `:MasonInstall` command, except
+that it only accepts LSP servers and - more importantly - only accepts
+lspconfig server names (as opposed to mason.nvim package names).
+
+You may also run the same command without any arguments. This will prompt you
+with a selection of servers that are recommended for the filetype of the
+buffer you're currently editing:
+
+ :LspInstall
+
==============================================================================
COMMANDS *mason-lspconfig-commands*