aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorWilliam Boman <william@redwill.se>2022-08-06 14:23:10 +0200
committerGitHub <noreply@github.com>2022-08-06 14:23:10 +0200
commitefd190d5c47be43ccc4e8ef81faa13c5d8b6508e (patch)
treefed23f7f8ac3928463379f1f3df70c9708184826 /README.md
parentfeat: add buildifier, blade-formatter, blue, haml-lint, textlint, vulture, cf... (diff)
downloadmason-efd190d5c47be43ccc4e8ef81faa13c5d8b6508e.tar
mason-efd190d5c47be43ccc4e8ef81faa13c5d8b6508e.tar.gz
mason-efd190d5c47be43ccc4e8ef81faa13c5d8b6508e.tar.bz2
mason-efd190d5c47be43ccc4e8ef81faa13c5d8b6508e.tar.lz
mason-efd190d5c47be43ccc4e8ef81faa13c5d8b6508e.tar.xz
mason-efd190d5c47be43ccc4e8ef81faa13c5d8b6508e.tar.zst
mason-efd190d5c47be43ccc4e8ef81faa13c5d8b6508e.zip
docs: add :help mason.nvim to README (#259)
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 15 insertions, 1 deletions
diff --git a/README.md b/README.md
index 79955d74..c3e2051f 100644
--- a/README.md
+++ b/README.md
@@ -7,12 +7,14 @@
<p align="center">
Portable package manager for Neovim that runs everywhere Neovim runs.<br />
- Easily install and manage LSP servers, DAP servers, linters, and formatters.
+ Easily install and manage LSP servers, DAP servers, linters, and formatters.<br />
+ <code>:help mason.nvim</code>
</p>
# Table of Contents
- [Introduction](#introduction)
+ - [How to use installed packages](#how-to-use-installed-packages)
- [Screenshots](#screenshots)
- [Requirements](#requirements)
- [Installation](#installation)
@@ -23,6 +25,8 @@
# Introduction
+> `:h mason-introduction`
+
`mason.nvim` is a Neovim plugin that allow you to easily manage external editor tooling such as LSP servers, DAP servers,
linters, and formatters through a single interface. It runs everywhere Neovim runs (across Linux, macOS, Windows, etc.),
with only a small set of [external requirements](#requirements) needed.
@@ -33,6 +37,8 @@ etc.) as well as other 3rd party plugins.
## How to use installed packages
+> `:h mason-how-to`
+
Although many packages are perfectly usable out of the box through Neovim builtins, it is recommended to use other 3rd
party plugins to further integrate these. The following plugins are recommended:
@@ -57,6 +63,8 @@ party plugins to further integrate these. The following plugins are recommended:
# Requirements
+> `:h mason-requirements`
+
`mason.nvim` relaxes the minimum requirements by attempting multiple different utilities (for example, `wget`,
`curl`, and `Invoke-WebRequest` are all perfect substitutes).
The _minimum_ recommended requirements are:
@@ -90,6 +98,8 @@ Plug 'williamboman/mason.nvim'
# Setup
+> `:h mason-quickstart`
+
```lua
require("mason").setup()
```
@@ -107,6 +117,8 @@ Refer to the [Wiki](https://github.com/williamboman/mason.nvim/wiki/Extensions)
# Commands
+> `:h mason-commands`
+
- `:Mason` - opens a graphical status window
- `:MasonInstall <package> ...` - installs/reinstalls the provided packages
- `:MasonUninstall <package> ...` - uninstalls the provided packages
@@ -115,6 +127,8 @@ Refer to the [Wiki](https://github.com/williamboman/mason.nvim/wiki/Extensions)
# Configuration
+> `:h mason-settings`
+
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.