From 9ea1f3b4ca957d2d482aef6411a3e7a3c01d5f63 Mon Sep 17 00:00:00 2001 From: Alexander Courtis Date: Sun, 21 May 2023 17:21:36 +1000 Subject: [PATCH 1/2] docs: add nvim-tree-netrw --- doc/nvim-tree-lua.txt | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/doc/nvim-tree-lua.txt b/doc/nvim-tree-lua.txt index 3954f014bb3..e61167948f5 100644 --- a/doc/nvim-tree-lua.txt +++ b/doc/nvim-tree-lua.txt @@ -26,6 +26,7 @@ CONTENTS *nvim-tree* 8. Events |nvim-tree-events| 9. Bookmarks |nvim-tree-bookmarks| 10. OS Specific Restrictions |nvim-tree-os-specific| + 11. Netrw |nvim-tree-netrw| ============================================================================== 1. INTRODUCTION *nvim-tree-introduction* @@ -359,7 +360,7 @@ applying configuration. glyphs = { default = "", symlink = "", - bookmark = "", + bookmark = "󰆤", modified = "●", folder = { arrow_closed = "", @@ -2225,4 +2226,25 @@ Windows WSL and PowerShell freeze nvim - Some filesystem watcher error related to permissions will not be reported +============================================================================== + 11. NETRW *nvim-tree-netrw* + +|netrw| is a standard neovim plugin that is enabled by default. It provides, +amongst other functionality, a file/directory browser. + +It interferes with nvim-tree and the intended user experience is nvim-tree +replacing the |netrw| browser. + +It is strongly recommended to disable |netrw|. As it is a bundled plugin it +must be disabled manually at the start of your `init.lua` as per |netrw-noload|: > + + vim.g.loaded_netrw = 1 + vim.g.loaded_netrwPlugin = 1 +< +There are many |netrw| features features beyond the file browser. If you want to +keep using |netrw| without its browser features please ensure: + +|nvim-tree.disable_netrw| `= false` +|nvim-tree.hijack_netrw| ` = true` + vim:tw=78:ts=4:sw=4:et:ft=help:norl: From 49b6ef3acb14f7b196ec57bdb1c7966142a36324 Mon Sep 17 00:00:00 2001 From: Alexander Courtis Date: Mon, 22 May 2023 10:36:32 +1000 Subject: [PATCH 2/2] docs: add nvim-tree-netrw --- README.md | 4 +++- doc/nvim-tree-lua.txt | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c2657847885..1ce9f184280 100644 --- a/README.md +++ b/README.md @@ -46,10 +46,12 @@ Please install via your preferred package manager. See [Installation](https://gi ## Quick Start +Disabling [netrw](https://neovim.io/doc/user/pi_netrw.html) is strongly advised, see [:help nvim-tree-netrw](doc/nvim-tree-lua.txt) + Setup the plugin in your `init.lua` ```lua --- disable netrw at the very start of your init.lua (strongly advised) +-- disable netrw at the very start of your init.lua vim.g.loaded_netrw = 1 vim.g.loaded_netrwPlugin = 1 diff --git a/doc/nvim-tree-lua.txt b/doc/nvim-tree-lua.txt index 45729d8b354..152602ddae8 100644 --- a/doc/nvim-tree-lua.txt +++ b/doc/nvim-tree-lua.txt @@ -79,9 +79,11 @@ Install the plugins via your package manager: `"nvim-tree/nvim-tree.lua"` `"nvim-tree/nvim-web-devicons"` +Disabling |netrw| is strongly advised, see |nvim-tree-netrw| + Setup the plugin in your `init.lua` > - -- disable netrw at the very start of your init.lua (strongly advised) + -- disable netrw at the very start of your init.lua vim.g.loaded_netrw = 1 vim.g.loaded_netrwPlugin = 1