Skip to content

docs: update to 0.12 help format, remove blank line help suppression #3314

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alex-courtis merged 1 commit into from
Apr 7, 2026
+1 −50
Merged

docs: update to 0.12 help format, remove blank line help suppression #3314

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,10 @@ help-update:

#
# CI
# --ignore-blank-lines is used as nightly has removed unnecessary blank lines that stable (0.11.5) currently inserts
#
help-check: help-update
scripts/vimdoc.sh lintdoc
git diff --ignore-blank-lines --exit-code doc/nvim-tree-lua.txt
git diff --exit-code doc/nvim-tree-lua.txt


.PHONY: all lint style check luacheck style-check style-doc luals format-fix format-check help-update help-check
Expand Down
48 changes: 0 additions & 48 deletions doc/nvim-tree-lua.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1075,8 +1075,6 @@ Config *nvim-tree-config*
• {log}? (`nvim_tree.config.log`)
|nvim_tree.config.log|



==============================================================================
Config: sort *nvim-tree-config-sort*

Expand Down Expand Up @@ -1115,8 +1113,6 @@ Config: sort *nvim-tree-config-sort*
folders. Has no effect when {sorter} is a function.
Overrides {folders_first}.



==============================================================================
Config: view *nvim-tree-config-view*

Expand Down Expand Up @@ -1201,8 +1197,6 @@ Config: view *nvim-tree-config-view*
• {padding}? (`nvim_tree.config.view.width.spec`, default: `1`)
Extra padding to the right.



==============================================================================
Config: renderer *nvim-tree-config-renderer*

Expand Down Expand Up @@ -1447,8 +1441,6 @@ Config: renderer *nvim-tree-config-renderer*
• {bottom}? (`string`) (default: `"─"`)
• {none}? (`string`) (default: `" "`)



==============================================================================
Config: hijack_directories *nvim-tree-config-hijack-directories*

Expand All @@ -1465,8 +1457,6 @@ Config: hijack_directories *nvim-tree-config-hijack-directories*
• {auto_open}? (`boolean`, default: `true`) Open if the tree was
previously closed.



==============================================================================
Config: update_focused_file *nvim-tree-config-update-focused-file*

Expand Down Expand Up @@ -1497,8 +1487,6 @@ Config: update_focused_file *nvim-tree-config-update-focused-file*
tree if the file isn't found under the current root
directory.



==============================================================================
Config: git *nvim-tree-config-git*

Expand Down Expand Up @@ -1531,8 +1519,6 @@ Config: git *nvim-tree-config-git*
• {cygwin_support}? (`boolean`, default: `false`) Use `cygpath` if
available to resolve paths for git.



==============================================================================
Config: diagnostics *nvim-tree-config-diagnostics*

Expand Down Expand Up @@ -1565,8 +1551,6 @@ Config: diagnostics *nvim-tree-config-diagnostics*
• {warning}? (`string`) (default: `""` )
• {error}? (`string`) (default: `""` )



==============================================================================
Config: modified *nvim-tree-config-modified*

Expand All @@ -1587,8 +1571,6 @@ Config: modified *nvim-tree-config-modified*
indication on open directories. Requires
{show_on_dirs}.



==============================================================================
Config: filters *nvim-tree-config-filters*

Expand Down Expand Up @@ -1642,8 +1624,6 @@ Config: filters *nvim-tree-config-filters*
(default: `{}`)
• {exclude}? (`string[]`) (default: `{}`)



==============================================================================
Config: live_filter *nvim-tree-config-live-filter*

Expand All @@ -1660,8 +1640,6 @@ Config: live_filter *nvim-tree-config-live-filter*
• {always_show_folders}? (`boolean`, default: `true`) Whether to filter
folders or not.



==============================================================================
Config: filesystem_watchers *nvim-tree-config-filesystem-watchers*

Expand Down Expand Up @@ -1708,8 +1686,6 @@ Config: filesystem_watchers *nvim-tree-config-filesystem-watchers*
{debounce_delay}. Set to 0 to allow unlimited
consecutive events.



==============================================================================
Config: actions *nvim-tree-config-actions*

Expand Down Expand Up @@ -1831,8 +1807,6 @@ Config: actions *nvim-tree-config-actions*
displays a file when removing that file from the
tree.



==============================================================================
Config: trash *nvim-tree-config-trash*

Expand All @@ -1846,8 +1820,6 @@ Config: trash *nvim-tree-config-trash*
Fields: ~
• {cmd}? (`string`) (default: `"gio trash"` or `"trash"`)



==============================================================================
Config: tab *nvim-tree-config-tab*

Expand All @@ -1867,8 +1839,6 @@ Config: tab *nvim-tree-config-tab*
• {ignore}? (`string[]`, default: `{}`) List of filetypes or buffer
names on new tab that will prevent `open` and `close`



==============================================================================
Config: notify *nvim-tree-config-notify*

Expand All @@ -1886,8 +1856,6 @@ Config: notify *nvim-tree-config-notify*
• {absolute_path}? (`boolean`, default: `true`) Use absolute paths in
FS action notifications, otherwise item names.



==============================================================================
Config: bookmarks *nvim-tree-config-bookmarks*

Expand All @@ -1900,8 +1868,6 @@ Config: bookmarks *nvim-tree-config-bookmarks*
Fields: ~
• {persist}? (`boolean|string`) (default: `false`)



==============================================================================
Config: help *nvim-tree-config-help*

Expand All @@ -1915,8 +1881,6 @@ Config: help *nvim-tree-config-help*
Fields: ~
• {sort_by}? (`nvim_tree.config.help.sort_by`) (default: `"key"`)



==============================================================================
Config: ui *nvim-tree-config-ui*

Expand All @@ -1935,8 +1899,6 @@ Config: ui *nvim-tree-config-ui*
• {default_yes}? (`boolean`, default: `false`) If `true` the prompt
will be `Y/n`, otherwise `y/N`



==============================================================================
Config: experimental *nvim-tree-config-experimental*

Expand All @@ -1946,8 +1908,6 @@ Config: experimental *nvim-tree-config-experimental*
In the event of a problem please disable the experiment and raise an
issue.



==============================================================================
Config: log *nvim-tree-config-log*

Expand Down Expand Up @@ -1982,8 +1942,6 @@ Config: log *nvim-tree-config-log*
|nvim_tree.config.filesystem_watchers| processing,
verbose.



==============================================================================
Config: Default *nvim-tree-config-default*

Expand Down Expand Up @@ -2273,8 +2231,6 @@ Following is the default configuration, see |nvim_tree.config| for details. >lua
}
<



==============================================================================
API *nvim-tree-api*

Expand Down Expand Up @@ -2354,8 +2310,6 @@ e.g. the following are functionally identical: >lua
• {dir}? (`table<"direct"|"indirect", nvim_tree.git.XY[]>`) direct
inclusive-or indirect status



==============================================================================
API: appearance *nvim-tree-api-appearance*

Expand Down Expand Up @@ -3466,6 +3420,4 @@ Contents of `my-decorator.lua`: >lua
return MyDecorator
<



vim:tw=78:ts=8:sw=4:sts=4:et:ft=help:norl:
Loading