diff options
| author | William Boman <william@redwill.se> | 2022-07-12 23:40:37 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-07-12 23:40:37 +0200 |
| commit | 8a0c352b9e792f3b18f6cbf8a22b368cbdc05494 (patch) | |
| tree | e96e5d58f9f72d72f0d2859b2b949c6bbce144c0 /README.md | |
| parent | chore!: remove ccls (#59) (diff) | |
| download | mason-8a0c352b9e792f3b18f6cbf8a22b368cbdc05494.tar mason-8a0c352b9e792f3b18f6cbf8a22b368cbdc05494.tar.gz mason-8a0c352b9e792f3b18f6cbf8a22b368cbdc05494.tar.bz2 mason-8a0c352b9e792f3b18f6cbf8a22b368cbdc05494.tar.lz mason-8a0c352b9e792f3b18f6cbf8a22b368cbdc05494.tar.xz mason-8a0c352b9e792f3b18f6cbf8a22b368cbdc05494.tar.zst mason-8a0c352b9e792f3b18f6cbf8a22b368cbdc05494.zip | |
docs: add docs for mason-lspconfig (#61)
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 26 |
1 files changed, 25 insertions, 1 deletions
@@ -24,6 +24,7 @@ - [Setup](#setup) - [Commands](#commands) - [Configuration](#configuration) +- [Extensions](#extensions) # Introduction @@ -80,6 +81,8 @@ Plug "williamboman/mason.nvim", { 'branch': 'alpha' } require("mason").setup {} ``` +Refer to [extensions](#extensions) for extra, opt-in, functionality! + Refer to the [Configuration](#configuration) section for information about which settings are available. # Commands @@ -92,7 +95,8 @@ Refer to the [Configuration](#configuration) section for information about which # Configuration -You may optionally configure certain behavior of `mason.nvim` when calling the `.setup()` function. +You may optionally configure certain behavior of `mason.nvim` when calling the `.setup()` function. Refer to the +[default configuration](#default-configuration) for a list of all available settings. Example: @@ -108,6 +112,8 @@ require("mason").setup({ }) ``` +## Default configuration + ```lua local DEFAULT_SETTINGS = { ui = { @@ -174,3 +180,21 @@ local DEFAULT_SETTINGS = { }, } ``` + +# Extensions + +## `mason-lspconfig` + +`mason-lspconfig` is a native extension to `mason.nvim` that ships with +`mason.nvim`. It bridges `mason.nvim` with the `lspconfig` plugin in order to +make it easier to use the both plugins together. + +It is recommended to use this extension if you use `lspconfig`. To use this extension, make sure to set it up after +`mason.nvim`, like so: + +```lua +require("mason").setup() +require("mason-lspconfig").setup() +``` + +For more documentation, see [`:h mason-lspconfig`](./doc/mason-lspconfig.txt). |
