diff options
| author | William Boman <william@redwill.se> | 2022-07-31 13:43:50 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-07-31 13:43:50 +0200 |
| commit | c3159a07fbeb93c820fbf0ba4757d94d9a1c45f6 (patch) | |
| tree | 2d1ffd93fc5138420abffeff573ec90f5adf91da | |
| parent | feat: add erb-lint (#204) (diff) | |
| download | mason-c3159a07fbeb93c820fbf0ba4757d94d9a1c45f6.tar mason-c3159a07fbeb93c820fbf0ba4757d94d9a1c45f6.tar.gz mason-c3159a07fbeb93c820fbf0ba4757d94d9a1c45f6.tar.bz2 mason-c3159a07fbeb93c820fbf0ba4757d94d9a1c45f6.tar.lz mason-c3159a07fbeb93c820fbf0ba4757d94d9a1c45f6.tar.xz mason-c3159a07fbeb93c820fbf0ba4757d94d9a1c45f6.tar.zst mason-c3159a07fbeb93c820fbf0ba4757d94d9a1c45f6.zip | |
docs: add section describing how to use packages (#206)
| -rw-r--r-- | README.md | 25 | ||||
| -rw-r--r-- | doc/mason.txt | 20 |
2 files changed, 41 insertions, 4 deletions
@@ -31,12 +31,29 @@ Packages are installed to Neovim's `:h stdpath` by default. Executables are link `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. +## How to use installed 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: + +- LSP: [`lspconfig`][lspconfig] & [`mason-lspconfig.nvim`][mason-lspconfig.nvim] +- DAP: [`nvim-dap`][nvim-dap] +- Linters: [`null-ls.nvim`][null-ls.nvim] or [`nvim-lint`][nvim-lint] +- Formatters: [`null-ls.nvim`][null-ls.nvim] or [`formatter.nvim`][formatter.nvim] + +[formatter.nvim]: https://github.com/mhartington/formatter.nvim +[lspconfig]: https://github.com/neovim/nvim-lspconfig +[mason-lspconfig.nvim]: https://github.com/williamboman/mason-lspconfig.nvim +[null-ls.nvim]: https://github.com/jose-elias-alvarez/null-ls.nvim +[nvim-dap]: https://github.com/mfussenegger/nvim-dap +[nvim-lint]: https://github.com/mfussenegger/nvim-lint + ## Screenshots -| | | | -| :--------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------: | -| <img alt="Main window" src="https://user-images.githubusercontent.com/6705160/177617680-d62caf26-f253-4ace-ab57-4b590595adca.png"> | <img src="https://user-images.githubusercontent.com/6705160/177617684-6bb4c13f-1235-4ac9-829e-120b06f7437b.png"> | <img alt="Language filter" src="https://user-images.githubusercontent.com/6705160/177617688-8f9ba225-00c8-495c-9c4c-b74240d6f280.png"> | -| <img alt="LSP server configuration schema" src="https://user-images.githubusercontent.com/6705160/177617692-02c6ddde-a97e-42b4-bca4-4f4caf45d569.png"> | <img alt="Checking for new versions" src="https://user-images.githubusercontent.com/6705160/180648183-69077d10-8795-4da6-ba4d-57ecf0cb25c9.png"> | <img alt="Help window" src="https://user-images.githubusercontent.com/6705160/180648292-136a0888-0fb6-4226-aa29-53bd3ffed400.png"> | +| | | | +| :----------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------: | +| <img alt="Main window" src="https://user-images.githubusercontent.com/6705160/177617680-d62caf26-f253-4ace-ab57-4b590595adca.png"> | <img src="https://user-images.githubusercontent.com/6705160/177617684-6bb4c13f-1235-4ac9-829e-120b06f7437b.png"> | <img alt="Language filter" src="https://user-images.githubusercontent.com/6705160/177617688-8f9ba225-00c8-495c-9c4c-b74240d6f280.png"> | +| <img alt="LSP server configuration schema" src="https://user-images.githubusercontent.com/6705160/177617692-02c6ddde-a97e-42b4-bca4-4f4caf45d569.png"> | <img alt="Checking for new versions" src="https://user-images.githubusercontent.com/6705160/180648183-69077d10-8795-4da6-ba4d-57ecf0cb25c9.png"> | <img alt="Help window" src="https://user-images.githubusercontent.com/6705160/180648292-136a0888-0fb6-4226-aa29-53bd3ffed400.png"> | # Requirements diff --git a/doc/mason.txt b/doc/mason.txt index acdc8dd0..d174791f 100644 --- a/doc/mason.txt +++ b/doc/mason.txt @@ -69,6 +69,26 @@ Please refer to each package's own release pages to find which versions are available. ============================================================================== +HOW TO USE PACKAGES *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: + +- LSP: `lspconfig` & `mason-lspconfig.nvim` +- DAP: `nvim-dap` +- Linters: `null-ls.nvim` or `nvim-lint` +- Formatters: `null-ls.nvim` or `formatter.nvim` + +formatter.nvim https://github.com/mhartington/formatter.nvim +lspconfig https://github.com/neovim/nvim-lspconfig +mason-lspconfig.nvim https://github.com/williamboman/mason-lspconfig.nvim +null-ls.nvim https://github.com/jose-elias-alvarez/null-ls.nvim +nvim-dap https://github.com/mfussenegger/nvim-dap +nvim-lint https://github.com/mfussenegger/nvim-lint + + +============================================================================== COMMANDS *mason-commands* *:Mason* |