aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAaron <79121360+UnrealApex@users.noreply.github.com>2023-03-26 11:00:23 +0000
committerGitHub <noreply@github.com>2023-03-26 13:00:23 +0200
commit5a910000a450d234e13e80a51a227c1e1ebb3bcd (patch)
tree48ab704aab4c6fab9c0a82e7e73bc410a2e61ac9
parentfeat(health): add registry and unzip (#1139) (diff)
downloadmason-5a910000a450d234e13e80a51a227c1e1ebb3bcd.tar
mason-5a910000a450d234e13e80a51a227c1e1ebb3bcd.tar.gz
mason-5a910000a450d234e13e80a51a227c1e1ebb3bcd.tar.bz2
mason-5a910000a450d234e13e80a51a227c1e1ebb3bcd.tar.lz
mason-5a910000a450d234e13e80a51a227c1e1ebb3bcd.tar.xz
mason-5a910000a450d234e13e80a51a227c1e1ebb3bcd.tar.zst
mason-5a910000a450d234e13e80a51a227c1e1ebb3bcd.zip
docs: clarify installation location and add more help links (#1138)
Co-authored-by: William Boman <william@redwill.se>
-rw-r--r--README.md26
1 files changed, 17 insertions, 9 deletions
diff --git a/README.md b/README.md
index c9828452..980dd90c 100644
--- a/README.md
+++ b/README.md
@@ -26,21 +26,21 @@
# Introduction
-> `:h mason-introduction`
+> [`:h mason-introduction`][help-mason-introduction]
`mason.nvim` is a Neovim plugin that allows 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.
-Packages are installed in Neovim's `:h stdpath` by default. Executables are linked to a single `bin/` directory, which
-`mason.nvim` will add to Neovim's PATH during setup, allowing seamless access from Neovim builtins (shell, terminal,
-etc.) as well as other 3rd party plugins.
+Packages are installed in Neovim's data directory ([`:h standard-path`][help-standard-path]) by default. Executables are
+linked to a single `bin/` directory, which `mason.nvim` will add to Neovim's PATH during setup, allowing seamless access
+from Neovim builtins (shell, terminal, etc.) as well as other 3rd party plugins.
For a list of all available packages, see [PACKAGES.md](./PACKAGES.md).
## How to use installed packages
-> `:h mason-how-to-use-packages`
+> [`:h mason-how-to-use-packages`][help-mason-how-to-use-packages]
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:
@@ -66,7 +66,7 @@ party plugins to further integrate these. The following plugins are recommended:
# Requirements
-> `:h mason-requirements`
+> [`:h mason-requirements`][help-mason-requirements]
`mason.nvim` relaxes the minimum requirements by attempting multiple different utilities (for example, `wget`,
`curl`, and `Invoke-WebRequest` are all perfect substitutes).
@@ -114,7 +114,7 @@ Plug 'williamboman/mason.nvim', { 'do': ':MasonUpdate' }
# Setup
-> `:h mason-quickstart`
+> [`:h mason-quickstart`][help-mason-quickstart]
```lua
require("mason").setup()
@@ -133,7 +133,7 @@ Refer to the [Wiki](https://github.com/williamboman/mason.nvim/wiki/Extensions)
# Commands
-> `:h mason-commands`
+> [`:h mason-commands`][help-mason-commands]
- `:Mason` - opens a graphical status window
- `:MasonUpdate` - updates all managed registries
@@ -144,7 +144,7 @@ Refer to the [Wiki](https://github.com/williamboman/mason.nvim/wiki/Extensions)
# Configuration
-> `:h mason-settings`
+> [`:h mason-settings`][help-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.
@@ -278,3 +278,11 @@ local DEFAULT_SETTINGS = {
<sup>
👋 didn't find what you were looking for? Try looking in the <a href="./doc/mason.txt">help docs</a> <code>:help mason.nvim</code>!
</sup>
+
+[help-mason-commands]: ./doc/mason.txt#L177
+[help-mason-how-to-use-packages]: ./doc/mason.txt#L153
+[help-mason-introduction]: ./doc/mason.txt#L11
+[help-mason-quickstart]: ./doc/mason.txt#L67
+[help-mason-requirements]: ./doc/mason.txt#L50
+[help-mason-settings]: ./doc/mason.txt#L237
+[help-standard-path]: https://neovim.io/doc/user/starting.html#standard-path