diff options
| -rw-r--r-- | README.md | 16 | ||||
| -rw-r--r-- | doc/mason.txt | 21 |
2 files changed, 26 insertions, 11 deletions
@@ -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. diff --git a/doc/mason.txt b/doc/mason.txt index d174791f..14f5e8b7 100644 --- a/doc/mason.txt +++ b/doc/mason.txt @@ -3,6 +3,7 @@ Minimum version of neovim: 0.7.0 Author: William Boman + Type |gO| to see the table of contents. ============================================================================== INTRODUCTION *mason-introduction* @@ -17,10 +18,10 @@ linked to a single `bin/` directory, which `mason.nvim` will add to the Neovim's PATH during setup, allowing easy access for the builtin shell/terminal as well as other 3rd party plugins. -API reference: ~ +API reference: https://github.com/williamboman/mason.nvim/blob/main/doc/reference.md -Extensions: ~ +Extensions: - https://github.com/williamboman/mason-lspconfig.nvim ============================================================================== @@ -277,10 +278,10 @@ is_installed({package_name}) this is a more efficient option than the Package:is_installed() method due to a smaller amount of modules required to load. - Parameters: ~ + Parameters: {package_name} - string - Returns: ~ + Returns: boolean *mason-registry.get_package()* @@ -290,10 +291,10 @@ get_package({package_name}) This function errors if a package cannot be found. - Parameters: ~ + Parameters: {package_name} - string - Returns: ~ + Returns: Package *mason-registry.get_installed_packages()* @@ -301,7 +302,7 @@ get_installed_packages() Returns all installed package instances. This is a slower function that loads more modules. - Returns: ~ + Returns: Package[] *mason-registry.get_installed_package_names()* @@ -309,7 +310,7 @@ get_installed_package_names() Returns all installed package names. This is a fast function that doesn't load any extra modules. - Returns: ~ + Returns: string[] *mason-registry.get_all_packages()* @@ -317,7 +318,7 @@ get_all_packages() Returns all package instances. This is a slower function that loads more modules. - Returns: ~ + Returns: Package[] *mason-registry.get_all_package_names()* @@ -325,7 +326,7 @@ get_all_package_names() Returns all package names. This is a fast function that doesn't load any extra modules. - Returns: ~ + Returns: string[] |