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

chore(vimdoc): Auto update

Browse Source
This commit is contained in:
hedyhli
2024-07-05 05:22:28 +00:00
committed by github-actions[bot]
parent 7d03ade418
commit b47d8225d8
1 changed files with 16 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
doc/outline.txt
View File

@@ -448,12 +448,13 @@ External providers: - Asciidoc
<https://github.com/msr1k/outline-asciidoc-provider.nvim> (no external <https://github.com/msr1k/outline-asciidoc-provider.nvim> (no external
requirements) requirements)
How to implement an external provider ~
EXTERNAL PROVIDERS ~ External providers are separate plugins that users can install in addition to
`outline.nvim`. Their names can be appended to the `providers.priority` list in
External providers can be appended to the `providers.priority` list. Each item the outline.nvim config. Each item in the `providers.priority` list is used to
in the list is appended to `"outline.providers.<item>"` to form an import path, form an import path `"outline.providers.<item>"` and then `require()`’ed for
for use as a provider. use as a provider.
External providers from plugins should define the provider module at External providers from plugins should define the provider module at
`lua/outline/providers/<name>.lua` with these functions: `lua/outline/providers/<name>.lua` with these functions:
@@ -472,14 +473,15 @@ External providers from plugins should define the provider module at
- param `callback` is a function that receives a list of symbols and the - param `callback` is a function that receives a list of symbols and the
`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 have these fields: The function should return a list of "symbol tables".
- name: string Each symbol table should have these fields:
- kind: integer - name: string – displayed in the outline
- kind: integer – determines the icon to use
- selectionRange: table with fields `start` and `end`, each have fields - selectionRange: table with fields `start` and `end`, each have fields
`line` and `character`, each integers `line` and `character`, each integers:
- range: table with fields `start` and `end`, each have fields `line` and `{ start = { line = ?, character = ? }, ['end'] = { line = ?, character = ? } }`
`character`, each integers - range: same as selectionRange
- children: list of table of symbols - children: list of symbol tables
- detail: (optional) string, shown for `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 good The built-in markdown <./lua/outline/providers/markdown.lua> provider is a good
@@ -488,8 +490,8 @@ and uses regex; the built-in norg <./lua/outline/providers/norg.lua> provider
is an example which uses treesitter. is an example which uses treesitter.
All providers should support at least nvim 0.7. You can make use of All providers should support at least nvim 0.7. You can make use of
`_G._outline_nvim_has` with fields `[8]` and `[9]` equivalent to `_G._outline_nvim_has` with fields `[8]`, `[9]`, and `[10]`. For instance,
`vim.fn.has('nvim-0.8') == 1` and `vim.fn.has('nvim-0.9') == 1` respectively. `_G._outline_nvim_has[8]` is equivalent to: `vim.fn.has('nvim-0.8') == 1`.
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.