diff options
| author | William Boman <william@redwill.se> | 2022-07-16 16:55:15 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-07-16 16:55:15 +0200 |
| commit | 2b9259270c03b75d1230603c988ae2f11e6f43f6 (patch) | |
| tree | a340727a88ed427351c14c9e5ffc4dffb91aba14 | |
| parent | feat(mason-lspconfig): add get_installed_servers() method & add more tests (#84) (diff) | |
| download | mason-2b9259270c03b75d1230603c988ae2f11e6f43f6.tar mason-2b9259270c03b75d1230603c988ae2f11e6f43f6.tar.gz mason-2b9259270c03b75d1230603c988ae2f11e6f43f6.tar.bz2 mason-2b9259270c03b75d1230603c988ae2f11e6f43f6.tar.lz mason-2b9259270c03b75d1230603c988ae2f11e6f43f6.tar.xz mason-2b9259270c03b75d1230603c988ae2f11e6f43f6.tar.zst mason-2b9259270c03b75d1230603c988ae2f11e6f43f6.zip | |
docs: add reference link to help (#85)
| -rw-r--r-- | doc/mason.txt | 3 | ||||
| -rw-r--r-- | doc/reference.md | 9 |
2 files changed, 10 insertions, 2 deletions
diff --git a/doc/mason.txt b/doc/mason.txt index 6037f85c..20773a2a 100644 --- a/doc/mason.txt +++ b/doc/mason.txt @@ -18,6 +18,9 @@ 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: ~ + https://github.com/williamboman/mason.nvim/blob/alpha/doc/reference.md + ============================================================================== EXTENSIONS *mason-extensions* diff --git a/doc/reference.md b/doc/reference.md index 8caa4134..ad807436 100644 --- a/doc/reference.md +++ b/doc/reference.md @@ -1,10 +1,15 @@ # Mason API reference -This document contains the API reference for `mason.nvim`'s' public APIs. +This document contains the API reference for `mason.nvim`'s' public APIs and is a more in-depth complementary to the +documentation available in `:h mason`. The intended audience of this document are plugin developers and people who want to further customize their own Neovim configuration. -Note that APIs not listed in this document are not considered public, and are subject to unannounced, breaking, changes. +Note that APIs not listed in this document (or `:h mason`) are not considered public, and are subject to unannounced, +breaking, changes. Use at own risk. + +Please [reach out](https://github.com/williamboman/mason.nvim/discussions/new?category=api-suggestions) if you think +something is missing or if something could be improved! - [Architecture diagram](#architecture-diagram) - [`PackageSpec`](#packagespec) |