diff --git a/doc/outline.txt b/doc/outline.txt index 18c416a..366c319 100644 --- a/doc/outline.txt +++ b/doc/outline.txt @@ -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* @@ -311,10 +311,15 @@ Show defaults ~ providers = { priority = { 'lsp', 'coc', 'markdown', 'norg' }, + -- Configuration for each provider (3rd party providers are supported) lsp = { -- Lsp client names to ignore blacklist_clients = {}, }, + markdown = { + -- List of supported ft's to use the markdown provider + filetypes = {'markdown'}, + }, }, symbols = { @@ -447,8 +452,11 @@ for use as a provider. External providers from plugins should define the provider module at `lua/outline/providers/.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. + The config table comes from the user’s configuration in the + `providers['provider-name']` table where `provider-name` is the + `require('outline.providers.').name`. - `get_status() -> string[]` (optional) Return a list of lines to be included in `:OutlineStatus` as supplementary information when this provider is active.