leigh/outline.nvim
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Clarify readme

Browse Source
This commit is contained in:
hedy
2023-11-29 21:32:59 +08:00
parent 4bd0a095af
commit cf194e43bc
1 changed files with 16 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -481,7 +481,7 @@ The current list of tested providers are:
1. Norg (requires `norg` parser for treesitter) 1. Norg (requires `norg` parser for treesitter)
External providers: External providers:
- [Asciidoc](https://github.com/msr1k/outline-asciidoc-provider.nvim) - [Asciidoc](https://github.com/msr1k/outline-asciidoc-provider.nvim) (no external requirements)
### External providers ### External providers
@@ -511,7 +511,7 @@ External providers from plugins should define the provider module at
`opts` table. `opts` table.
- param `opts` can be passed to `callback` without processing - param `opts` can be passed to `callback` without processing
Each symbol table in the list of symbols should these fields: Each symbol table in the list of symbols should have these fields:
- name: string - name: string
- kind: integer - kind: integer
- selectionRange: table with fields `start` and `end`, each have fields - selectionRange: table with fields `start` and `end`, each have fields
@@ -519,7 +519,7 @@ External providers from plugins should define the provider module at
- range: table with fields `start` and `end`, each have fields `line` and - range: table with fields `start` and `end`, each have fields `line` and
`character`, each integers `character`, each integers
- children: list of table of symbols - children: list of table of symbols
- detail: (optional) string, shown as `outline_items.show_symbol_details` - detail: (optional) string, shown for `outline_items.show_symbol_details`
The built-in [markdown](./lua/outline/providers/markdown.lua) provider is a The built-in [markdown](./lua/outline/providers/markdown.lua) provider is a
good example of a very simple outline-provider module which parses raw buffer good example of a very simple outline-provider module which parses raw buffer
@@ -533,6 +533,14 @@ All providers should support at least nvim 0.7. You can make use of
If a higher nvim version is required, it is recommended to check for this If a higher nvim version is required, it is recommended to check for this
requirement in the `supports_buffer` function. requirement in the `supports_buffer` function.
Hover symbol, code action and rename functions are defined from providers. You
can customize what these functions do if these functions are triggered when
your provider is active. See the built-in
[LSP](./lua/outline/providers/nvim-lsp.lua) provider for an example.
Other functions such as goto-location may also be delegated to providers in the
future.
## Commands ## Commands
@@ -1148,12 +1156,13 @@ That said, per-tabpage outline is supported.
Outline.nvim. Outline.nvim.
Aerial does a great job at supercharging vim's built-in outline (`gO`). It Aerial does a great job at supercharging vim's built-in outline (`gO`). It
supports treesitter and vimdoc which Outline.nvim does not provide by default. supports treesitter and manpages which Outline.nvim does not provide [by
(Note that Aerial also supports Norg through treesitter like Outline.nvim, but default](#external-providers). (Note that Aerial also supports Norg through
as of writing it does not support JSX like Outline.nvim does.) treesitter like Outline.nvim, but as of writing it does not support JSX like
Outline.nvim does.)
- If you wish to prioritize treesitter as the provider ("backend" in Aerial's - If you wish to prioritize treesitter as the provider ("backend" in Aerial's
terms) for your symbols, you should use Aerial. This lets your have symbols terms) for your symbols, you should use Aerial. This lets you have symbols
for languages that you might not want to set up an LSP for, which is quite for languages that you might not want to set up an LSP for, which is quite
useful. Treesitter support is a planned feature in Outline.nvim but might useful. Treesitter support is a planned feature in Outline.nvim but might
not arrive very soon. not arrive very soon.