Skip to content

Commit

Permalink
feat(#2948): improve doc
Browse files Browse the repository at this point in the history
  • Loading branch information
alex-courtis committed Dec 1, 2024
1 parent 47156b3 commit 72ef08b
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions doc/nvim-tree-lua.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2770,18 +2770,16 @@ configurations for different types of prompts.
==============================================================================
11. DECORATORS *nvim-tree-decorators*

Highlighting and icons for nodes are is provided by Decorators. You may provide
Highlighting and icons for nodes are provided by Decorators. You may provide
your own in addition to the builtin decorators.

Decorators may:
- Add icons
- Set highlight group for the name or icons
- Override node icon

See `api_decorator.lua` for decorator class definition and full documentation.

Specify decorators and their precedence via |nvim-tree.renderer.decorators|
e.g. defaults with a user decorator being overridden only by Cut: >lua
e.g. defaults with a user decorator class being overridden only by Cut: >lua
{
"Git",
"Open",
Expand All @@ -2793,6 +2791,9 @@ e.g. defaults with a user decorator being overridden only by Cut: >lua
MyDecorator,
"Cut",
}

See `nvim-tree/_meta/api_decorator.lua` for full
`nvim_tree.api.decorator.UserDecorator` class documentation.
<
==============================================================================
11.1. DECORATOR EXAMPLE *nvim-tree-decorator-example*
Expand Down

0 comments on commit 72ef08b

Please sign in to comment.