tomas.mirchev/nvim-tree.lua
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: tidy help

Browse Source
This commit is contained in:
Alexander Courtis
2022-06-25 11:23:19 +10:00
parent 79258f1d67
commit 7160e68d5a
1 changed files with 82 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
doc/nvim-tree-lua.txt
View File

@@ -5,15 +5,15 @@ Author: Yazdani Kiyan <yazdani.kiyan@protonmail.com>
==============================================================================
CONTENTS *nvim-tree*
1. Introduction nvim-tree-introduction
2. Quickstart nvim-tree-quickstart
3. Commands nvim-tree-commands
4. Setup/Configuration nvim-tree-setup
4.1 Vinegar Style nvim-tree-vinegar
5. Mappings nvim-tree-mappings
6. Highlight Groups nvim-tree-highlight
7. Events nvim-tree-events
7.1 Available Events nvim-tree.events
1. Introduction |nvim-tree-introduction|
2. Quickstart |nvim-tree-quickstart|
3. Commands |nvim-tree-commands|
4. Setup/Configuration |nvim-tree-setup|
4.1 Vinegar Style |nvim-tree-vinegar|
5. Mappings |nvim-tree-mappings|
6. Highlight Groups |nvim-tree-highlight|
7. Events |nvim-tree-events|
7.1 Available Events |nvim-tree.events|
==============================================================================
1. INTRODUCTION *nvim-tree-introduction*
@@ -465,7 +465,7 @@ Configuration options for the system open command.
Type: {string}, Default: `{}`
*nvim-tree.diagnostics*
Show lsp diagnostics in the signcolumn
Show LSP and COC diagnostics in the signcolumn
*nvim-tree.diagnostics.enable*
Enable/disable the feature.
@@ -513,7 +513,6 @@ Git integration with icons and colors.
milliseconds but a few seconds), it will not render anything until the git
process returned the data.
*nvim-tree.filesystem_watchers*
Will use file system watcher (libuv fs_poll) to watch the filesystem for
changes.
@@ -587,7 +586,7 @@ Window / buffer setup.
Type: `string`, Default: `"yes"`
*nvim-tree.view.mappings*
Configuration options for keymaps
Configuration options for |nvim-tree-mappings|
*nvim-tree.view.mappings.custom_only*
Will use only the provided user mappings and not the default otherwise,
@@ -595,8 +594,7 @@ Window / buffer setup.
Type: `boolean`, Default: `false`
*nvim-tree.view.mappings.list*
A list of keymaps that will extend or override the default keymaps,
see |nvim-tree-mappings|.
A list of keymaps that will extend or override the default keymaps.
Type: `table`
Default: see |nvim-tree-default-mappings|
@@ -761,6 +759,9 @@ Configuration options for trashing.
*nvim-tree.actions*
Configuration for various actions.
*nvim-tree.actions.change_dir*
vim |current-directory| behaviour.
*nvim-tree.actions.change_dir.enable*
Change the working directory when changing directories in the tree.
Type: `boolean`, Default: `true`
@@ -779,6 +780,9 @@ Configuration for various actions.
Avoids hanging neovim when running this action on very large folders.
Type: `number`, Default: `300`
*nvim-tree.actions.open_file*
Configuration options for opening a file from nvim-tree.
*nvim-tree.actions.open_file.quit_on_open*
Closes the explorer when opening a file.
It will also disable preventing a buffer overriding the tree.
@@ -865,8 +869,16 @@ Configuration for diagnostic logging.
File copy and paste actions.
Type: `boolean`, Default: `false`
*nvim-tree.log.types.diagnostics*
LSP and COC processing, verbose.
Type: `boolean`, Default: `false`
*nvim-tree.log.types.git*
Git processing.
Git processing, verbose.
Type: `boolean`, Default: `false`
*nvim-tree.log.types.watcher*
*nvim-tree.filesystem_watchers* processing, verbose.
Type: `boolean`, Default: `false`
==============================================================================