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-03-16 00:13:57 +00:00
committed by github-actions[bot]
parent ec9571c8f0
commit bdfd2da90e
1 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
doc/outline.txt
View File

@@ -1,4 +1,4 @@
*outline.txt* For NVIM v0.7.0 Last change: 2024 January 22 *outline.txt* For NVIM v0.7.0 Last change: 2024 March 16
============================================================================== ==============================================================================
Table of Contents *outline-table-of-contents* Table of Contents *outline-table-of-contents*
@@ -311,10 +311,15 @@ Show defaults ~
providers = { providers = {
priority = { 'lsp', 'coc', 'markdown', 'norg' }, priority = { 'lsp', 'coc', 'markdown', 'norg' },
-- Configuration for each provider (3rd party providers are supported)
lsp = { lsp = {
-- Lsp client names to ignore -- Lsp client names to ignore
blacklist_clients = {}, blacklist_clients = {},
}, },
markdown = {
-- List of supported ft's to use the markdown provider
filetypes = {'markdown'},
},
}, },
symbols = { symbols = {
@@ -447,8 +452,11 @@ for 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:
- `supports_buffer(bufnr: integer) -> boolean` - `supports_buffer(bufnr: integer, config: table?) -> boolean`
This function could check buffer filetype, existence of required modules, etc. This function could check buffer filetype, existence of required modules, etc.
The config table comes from the user’s configuration in the
`providers['provider-name']` table where `provider-name` is the
`require('outline.providers.<name>').name`.
- `get_status() -> string[]` (optional) - `get_status() -> string[]` (optional)
Return a list of lines to be included in `:OutlineStatus` as supplementary Return a list of lines to be included in `:OutlineStatus` as supplementary
information when this provider is active. information when this provider is active.