mirror of
https://github.com/nvim-tree/nvim-tree.lua
synced 2024-09-16 14:34:03 +02:00
docs: add help indexes (#2684)
* docs: add nvim-tree-index-api * docs: add nvim-tree-index-opts * docs: add nvim-tree-index-api * docs: sort indices * docs: less verbose * docs: use dictionary sort for indices
This commit is contained in:
Alexander Courtis
GitHub
parent
7efaa339d3
commit
d52fdeb0a3
3 changed files with 303 additions and 0 deletions
|
|
@ -69,10 +69,16 @@ Once you did, you should run `make help-update`
|
|||
|
||||
# Documentation
|
||||
|
||||
## Opts
|
||||
|
||||
When adding new options, you should declare the defaults in the main `nvim-tree.lua` file.
|
||||
|
||||
Documentation for options should also be added to `nvim-tree-opts` in `doc/nvim-tree-lua.txt`
|
||||
|
||||
## API
|
||||
|
||||
When adding or changing API please update :help nvim-tree-api
|
||||
|
||||
# Pull Request
|
||||
|
||||
Please reference any issues in the description e.g. "resolves #1234".
|
||||
|
|
|
|||
|
|
@ -57,6 +57,9 @@ CONTENTS *nvim-tree*
|
|||
13. Legacy |nvim-tree-legacy|
|
||||
13.1 Legacy: Opts |nvim-tree-legacy-opts|
|
||||
13.2 Legacy: Highlight |nvim-tree-legacy-highlight|
|
||||
14. Index |nvim-tree-index|
|
||||
14.1 Index: Opts |nvim-tree-index-opts|
|
||||
14.2 Index: API |nvim-tree-index-api|
|
||||
|
||||
==============================================================================
|
||||
1. INTRODUCTION *nvim-tree-introduction*
|
||||
|
|
@ -2710,4 +2713,265 @@ highlight group is not, hard linking as follows: >
|
|||
NvimTreeLspDiagnosticsInformationFolderText NvimTreeDiagnosticInfoFolderHL
|
||||
NvimTreeLspDiagnosticsHintFolderText NvimTreeDiagnosticHintFolderHL
|
||||
<
|
||||
==============================================================================
|
||||
14 INDEX *nvim-tree-index*
|
||||
|
||||
==============================================================================
|
||||
14.1 INDEX: OPTS *nvim-tree-index-opts*
|
||||
|
||||
|nvim-tree.actions.change_dir|
|
||||
|nvim-tree.actions.change_dir.enable|
|
||||
|nvim-tree.actions.change_dir.global|
|
||||
|nvim-tree.actions.change_dir.restrict_above_cwd|
|
||||
|nvim-tree.actions.expand_all|
|
||||
|nvim-tree.actions.expand_all.exclude|
|
||||
|nvim-tree.actions.expand_all.max_folder_discovery|
|
||||
|nvim-tree.actions.file_popup|
|
||||
|nvim-tree.actions.file_popup.open_win_config|
|
||||
|nvim-tree.actions.open_file|
|
||||
|nvim-tree.actions.open_file.eject|
|
||||
|nvim-tree.actions.open_file.quit_on_open|
|
||||
|nvim-tree.actions.open_file.resize_window|
|
||||
|nvim-tree.actions.open_file.window_picker|
|
||||
|nvim-tree.actions.open_file.window_picker.chars|
|
||||
|nvim-tree.actions.open_file.window_picker.enable|
|
||||
|nvim-tree.actions.open_file.window_picker.exclude|
|
||||
|nvim-tree.actions.open_file.window_picker.picker|
|
||||
|nvim-tree.actions.remove_file.close_window|
|
||||
|nvim-tree.actions.use_system_clipboard|
|
||||
|nvim-tree.auto_reload_on_write|
|
||||
|nvim-tree.diagnostics.debounce_delay|
|
||||
|nvim-tree.diagnostics.enable|
|
||||
|nvim-tree.diagnostics.icons|
|
||||
|nvim-tree.diagnostics.severity|
|
||||
|nvim-tree.diagnostics.severity.max|
|
||||
|nvim-tree.diagnostics.severity.min|
|
||||
|nvim-tree.diagnostics.show_on_dirs|
|
||||
|nvim-tree.diagnostics.show_on_open_dirs|
|
||||
|nvim-tree.disable_netrw|
|
||||
|nvim-tree.experimental|
|
||||
|nvim-tree.filesystem_watchers.debounce_delay|
|
||||
|nvim-tree.filesystem_watchers.enable|
|
||||
|nvim-tree.filesystem_watchers.ignore_dirs|
|
||||
|nvim-tree.filters.custom|
|
||||
|nvim-tree.filters.dotfiles|
|
||||
|nvim-tree.filters.exclude|
|
||||
|nvim-tree.filters.git_clean|
|
||||
|nvim-tree.filters.git_ignored|
|
||||
|nvim-tree.filters.no_bookmark|
|
||||
|nvim-tree.filters.no_buffer|
|
||||
|nvim-tree.git.cygwin_support|
|
||||
|nvim-tree.git.disable_for_dirs|
|
||||
|nvim-tree.git.enable|
|
||||
|nvim-tree.git.show_on_dirs|
|
||||
|nvim-tree.git.show_on_open_dirs|
|
||||
|nvim-tree.git.timeout|
|
||||
|nvim-tree.help.sort_by|
|
||||
|nvim-tree.hijack_cursor|
|
||||
|nvim-tree.hijack_directories.auto_open|
|
||||
|nvim-tree.hijack_directories.enable|
|
||||
|nvim-tree.hijack_netrw|
|
||||
|nvim-tree.hijack_unnamed_buffer_when_opening|
|
||||
|nvim-tree.live_filter.always_show_folders|
|
||||
|nvim-tree.live_filter.prefix|
|
||||
|nvim-tree.log.enable|
|
||||
|nvim-tree.log.truncate|
|
||||
|nvim-tree.log.types|
|
||||
|nvim-tree.log.types.all|
|
||||
|nvim-tree.log.types.config|
|
||||
|nvim-tree.log.types.copy_paste|
|
||||
|nvim-tree.log.types.dev|
|
||||
|nvim-tree.log.types.diagnostics|
|
||||
|nvim-tree.log.types.git|
|
||||
|nvim-tree.log.types.profile|
|
||||
|nvim-tree.log.types.watcher|
|
||||
|nvim-tree.modified.enable|
|
||||
|nvim-tree.modified.show_on_dirs|
|
||||
|nvim-tree.modified.show_on_open_dirs|
|
||||
|nvim-tree.notify.threshold|
|
||||
|nvim-tree.on_attach|
|
||||
|nvim-tree.prefer_startup_root|
|
||||
|nvim-tree.reload_on_bufenter|
|
||||
|nvim-tree.renderer.add_trailing|
|
||||
|nvim-tree.renderer.full_name|
|
||||
|nvim-tree.renderer.group_empty|
|
||||
|nvim-tree.renderer.highlight_bookmarks|
|
||||
|nvim-tree.renderer.highlight_clipboard|
|
||||
|nvim-tree.renderer.highlight_diagnostics|
|
||||
|nvim-tree.renderer.highlight_git|
|
||||
|nvim-tree.renderer.highlight_modified|
|
||||
|nvim-tree.renderer.highlight_opened_files|
|
||||
|nvim-tree.renderer.icons|
|
||||
|nvim-tree.renderer.icons.bookmarks_placement|
|
||||
|nvim-tree.renderer.icons.diagnostics_placement|
|
||||
|nvim-tree.renderer.icons.git_placement|
|
||||
|nvim-tree.renderer.icons.glyphs|
|
||||
|nvim-tree.renderer.icons.glyphs.default|
|
||||
|nvim-tree.renderer.icons.glyphs.folder|
|
||||
|nvim-tree.renderer.icons.glyphs.git|
|
||||
|nvim-tree.renderer.icons.glyphs.modified|
|
||||
|nvim-tree.renderer.icons.glyphs.symlink|
|
||||
|nvim-tree.renderer.icons.modified_placement|
|
||||
|nvim-tree.renderer.icons.padding|
|
||||
|nvim-tree.renderer.icons.show|
|
||||
|nvim-tree.renderer.icons.show.bookmarks|
|
||||
|nvim-tree.renderer.icons.show.diagnostics|
|
||||
|nvim-tree.renderer.icons.show.file|
|
||||
|nvim-tree.renderer.icons.show.folder|
|
||||
|nvim-tree.renderer.icons.show.folder_arrow|
|
||||
|nvim-tree.renderer.icons.show.git|
|
||||
|nvim-tree.renderer.icons.show.modified|
|
||||
|nvim-tree.renderer.icons.symlink_arrow|
|
||||
|nvim-tree.renderer.icons.web_devicons|
|
||||
|nvim-tree.renderer.icons.web_devicons.file|
|
||||
|nvim-tree.renderer.icons.web_devicons.file.color|
|
||||
|nvim-tree.renderer.icons.web_devicons.file.enable|
|
||||
|nvim-tree.renderer.icons.web_devicons.folder|
|
||||
|nvim-tree.renderer.icons.web_devicons.folder.color|
|
||||
|nvim-tree.renderer.icons.web_devicons.folder.enable|
|
||||
|nvim-tree.renderer.indent_markers|
|
||||
|nvim-tree.renderer.indent_markers.enable|
|
||||
|nvim-tree.renderer.indent_markers.icons|
|
||||
|nvim-tree.renderer.indent_markers.inline_arrows|
|
||||
|nvim-tree.renderer.indent_width|
|
||||
|nvim-tree.renderer.root_folder_label|
|
||||
|nvim-tree.renderer.special_files|
|
||||
|nvim-tree.renderer.symlink_destination|
|
||||
|nvim-tree.respect_buf_cwd|
|
||||
|nvim-tree.root_dirs|
|
||||
|nvim-tree.select_prompts|
|
||||
|nvim-tree.sort.files_first|
|
||||
|nvim-tree.sort.folders_first|
|
||||
|nvim-tree.sort.sorter|
|
||||
|nvim-tree.sync_root_with_cwd|
|
||||
|nvim-tree.system_open.args|
|
||||
|nvim-tree.system_open.cmd|
|
||||
|nvim-tree.tab.sync|
|
||||
|nvim-tree.tab.sync.close|
|
||||
|nvim-tree.tab.sync.ignore|
|
||||
|nvim-tree.tab.sync.open|
|
||||
|nvim-tree.trash.cmd|
|
||||
|nvim-tree.ui.confirm|
|
||||
|nvim-tree.ui.confirm.default_yes|
|
||||
|nvim-tree.ui.confirm.remove|
|
||||
|nvim-tree.ui.confirm.trash|
|
||||
|nvim-tree.update_focused_file.enable|
|
||||
|nvim-tree.update_focused_file.ignore_list|
|
||||
|nvim-tree.update_focused_file.update_root|
|
||||
|nvim-tree.view.centralize_selection|
|
||||
|nvim-tree.view.cursorline|
|
||||
|nvim-tree.view.debounce_delay|
|
||||
|nvim-tree.view.float|
|
||||
|nvim-tree.view.float.enable|
|
||||
|nvim-tree.view.float.open_win_config|
|
||||
|nvim-tree.view.float.quit_on_focus_loss|
|
||||
|nvim-tree.view.number|
|
||||
|nvim-tree.view.preserve_window_proportions|
|
||||
|nvim-tree.view.relativenumber|
|
||||
|nvim-tree.view.side|
|
||||
|nvim-tree.view.signcolumn|
|
||||
|nvim-tree.view.width|
|
||||
|nvim-tree.view.width.max|
|
||||
|nvim-tree.view.width.min|
|
||||
|nvim-tree.view.width.padding|
|
||||
|
||||
==============================================================================
|
||||
14.2 INDEX: API *nvim-tree-index-api*
|
||||
|
||||
|nvim-tree-api.commands.get()|
|
||||
|nvim-tree-api.config.mappings.default_on_attach()|
|
||||
|nvim-tree-api.config.mappings.get_keymap()|
|
||||
|nvim-tree-api.config.mappings.get_keymap_default()|
|
||||
|nvim-tree-api.diagnostics.hi_test()|
|
||||
|nvim-tree-api.events.subscribe()|
|
||||
|nvim-tree-api.fs.clear_clipboard()|
|
||||
|nvim-tree-api.fs.copy.absolute_path()|
|
||||
|nvim-tree-api.fs.copy.filename()|
|
||||
|nvim-tree-api.fs.copy.node()|
|
||||
|nvim-tree-api.fs.copy.relative_path()|
|
||||
|nvim-tree-api.fs.create()|
|
||||
|nvim-tree-api.fs.cut()|
|
||||
|nvim-tree-api.fs.paste()|
|
||||
|nvim-tree-api.fs.print_clipboard()|
|
||||
|nvim-tree-api.fs.remove()|
|
||||
|nvim-tree-api.fs.rename()|
|
||||
|nvim-tree-api.fs.rename_basename()|
|
||||
|nvim-tree-api.fs.rename_full()|
|
||||
|nvim-tree-api.fs.rename_node()|
|
||||
|nvim-tree-api.fs.rename_sub()|
|
||||
|nvim-tree-api.fs.trash()|
|
||||
|nvim-tree-api.git.reload()|
|
||||
|nvim-tree-api.live_filter.clear()|
|
||||
|nvim-tree-api.live_filter.start()|
|
||||
|nvim-tree-api.marks.bulk.delete()|
|
||||
|nvim-tree-api.marks.bulk.move()|
|
||||
|nvim-tree-api.marks.bulk.trash()|
|
||||
|nvim-tree-api.marks.clear()|
|
||||
|nvim-tree-api.marks.get()|
|
||||
|nvim-tree-api.marks.list()|
|
||||
|nvim-tree-api.marks.navigate.next()|
|
||||
|nvim-tree-api.marks.navigate.prev()|
|
||||
|nvim-tree-api.marks.navigate.select()|
|
||||
|nvim-tree-api.marks.toggle()|
|
||||
|nvim-tree-api.node.navigate.diagnostics.next()|
|
||||
|nvim-tree-api.node.navigate.diagnostics.next_recursive()|
|
||||
|nvim-tree-api.node.navigate.diagnostics.prev()|
|
||||
|nvim-tree-api.node.navigate.diagnostics.prev_recursive()|
|
||||
|nvim-tree-api.node.navigate.git.next()|
|
||||
|nvim-tree-api.node.navigate.git.next_recursive()|
|
||||
|nvim-tree-api.node.navigate.git.next_skip_gitignored()|
|
||||
|nvim-tree-api.node.navigate.git.prev()|
|
||||
|nvim-tree-api.node.navigate.git.prev_recursive()|
|
||||
|nvim-tree-api.node.navigate.git.prev_skip_gitignored()|
|
||||
|nvim-tree-api.node.navigate.opened.next()|
|
||||
|nvim-tree-api.node.navigate.opened.prev()|
|
||||
|nvim-tree-api.node.navigate.parent()|
|
||||
|nvim-tree-api.node.navigate.parent_close()|
|
||||
|nvim-tree-api.node.navigate.sibling.first()|
|
||||
|nvim-tree-api.node.navigate.sibling.last()|
|
||||
|nvim-tree-api.node.navigate.sibling.next()|
|
||||
|nvim-tree-api.node.navigate.sibling.prev()|
|
||||
|nvim-tree-api.node.open.drop()|
|
||||
|nvim-tree-api.node.open.edit()|
|
||||
|nvim-tree-api.node.open.horizontal()|
|
||||
|nvim-tree-api.node.open.no_window_picker()|
|
||||
|nvim-tree-api.node.open.preview()|
|
||||
|nvim-tree-api.node.open.preview_no_picker()|
|
||||
|nvim-tree-api.node.open.replace_tree_buffer()|
|
||||
|nvim-tree-api.node.open.tab()|
|
||||
|nvim-tree-api.node.open.tab_drop()|
|
||||
|nvim-tree-api.node.open.toggle_group_empty()|
|
||||
|nvim-tree-api.node.open.vertical()|
|
||||
|nvim-tree-api.node.run.cmd()|
|
||||
|nvim-tree-api.node.run.system()|
|
||||
|nvim-tree-api.node.show_info_popup()|
|
||||
|nvim-tree-api.tree.change_root()|
|
||||
|nvim-tree-api.tree.change_root_to_node()|
|
||||
|nvim-tree-api.tree.change_root_to_parent()|
|
||||
|nvim-tree-api.tree.close()|
|
||||
|nvim-tree-api.tree.close_in_all_tabs()|
|
||||
|nvim-tree-api.tree.close_in_this_tab()|
|
||||
|nvim-tree-api.tree.collapse_all()|
|
||||
|nvim-tree-api.tree.expand_all()|
|
||||
|nvim-tree-api.tree.find_file()|
|
||||
|nvim-tree-api.tree.focus()|
|
||||
|nvim-tree-api.tree.get_nodes()|
|
||||
|nvim-tree-api.tree.get_node_under_cursor()|
|
||||
|nvim-tree-api.tree.is_tree_buf()|
|
||||
|nvim-tree-api.tree.is_visible()|
|
||||
|nvim-tree-api.tree.open()|
|
||||
|nvim-tree-api.tree.reload()|
|
||||
|nvim-tree-api.tree.search_node()|
|
||||
|nvim-tree-api.tree.toggle()|
|
||||
|nvim-tree-api.tree.toggle_custom_filter()|
|
||||
|nvim-tree-api.tree.toggle_git_clean_filter()|
|
||||
|nvim-tree-api.tree.toggle_gitignore_filter()|
|
||||
|nvim-tree-api.tree.toggle_help()|
|
||||
|nvim-tree-api.tree.toggle_hidden_filter()|
|
||||
|nvim-tree-api.tree.toggle_no_bookmark_filter()|
|
||||
|nvim-tree-api.tree.toggle_no_buffer_filter()|
|
||||
|nvim-tree-api.tree.winid()|
|
||||
|
||||
==============================================================================
|
||||
|
||||
vim:tw=78:ts=4:sw=4:et:ft=help:norl:
|
||||
|
|
|
|||
|
|
@ -21,6 +21,39 @@ sed -e "s/^ / /" /tmp/DEFAULT_OPTS.2.lua > /tmp/DEFAULT_OPTS.6.lua
|
|||
sed -i -e "/${begin}/,/${end}/{ /${begin}/{p; r /tmp/DEFAULT_OPTS.6.lua
|
||||
}; /${end}/p; d; }" doc/nvim-tree-lua.txt
|
||||
|
||||
|
||||
#
|
||||
# opts index
|
||||
#
|
||||
begin="nvim-tree-index-opts\*"
|
||||
end="====================="
|
||||
|
||||
printf '\n' > /tmp/index-opts.txt
|
||||
sed -E "
|
||||
/^ *\*(nvim-tree\..*)\*$/! d ;
|
||||
s/^.*\*(.*)\*/|\1|/g
|
||||
" doc/nvim-tree-lua.txt | sort -d >> /tmp/index-opts.txt
|
||||
printf '\n' >> /tmp/index-opts.txt
|
||||
|
||||
sed -i -e "/${begin}/,/${end}/{ /${begin}/{p; r /tmp/index-opts.txt
|
||||
}; /${end}/p; d; }" doc/nvim-tree-lua.txt
|
||||
|
||||
#
|
||||
# api index
|
||||
#
|
||||
begin="nvim-tree-index-api\*"
|
||||
end="====================="
|
||||
|
||||
printf '\n' > /tmp/index-api.txt
|
||||
sed -E "
|
||||
/\*(nvim-tree-api.*\(\))\*/! d ;
|
||||
s/^.*\*(.*)\*/|\1|/g
|
||||
" doc/nvim-tree-lua.txt | sort -d >> /tmp/index-api.txt
|
||||
printf '\n' >> /tmp/index-api.txt
|
||||
|
||||
sed -i -e "/${begin}/,/${end}/{ /${begin}/{p; r /tmp/index-api.txt
|
||||
}; /${end}/p; d; }" doc/nvim-tree-lua.txt
|
||||
|
||||
#
|
||||
# DEFAULT_ON_ATTACH
|
||||
#
|
||||
|
|
|
|||
Loading…
Reference in a new issue