Skip to content

Commit 9ef6c3c

Browse files
authored
docs: add nvim-tree-netrw (#2222)
* docs: add nvim-tree-netrw * docs: add nvim-tree-netrw
1 parent b1e074d commit 9ef6c3c

File tree

2 files changed

+29
-3
lines changed

2 files changed

+29
-3
lines changed

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,12 @@ Please install via your preferred package manager. See [Installation](https://gi
4646

4747
## Quick Start
4848

49+
Disabling [netrw](https://neovim.io/doc/user/pi_netrw.html) is strongly advised, see [:help nvim-tree-netrw](doc/nvim-tree-lua.txt)
50+
4951
Setup the plugin in your `init.lua`
5052

5153
```lua
52-
-- disable netrw at the very start of your init.lua (strongly advised)
54+
-- disable netrw at the very start of your init.lua
5355
vim.g.loaded_netrw = 1
5456
vim.g.loaded_netrwPlugin = 1
5557

doc/nvim-tree-lua.txt

+26-2
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ CONTENTS *nvim-tree*
2626
8. Events |nvim-tree-events|
2727
9. Bookmarks |nvim-tree-bookmarks|
2828
10. OS Specific Restrictions |nvim-tree-os-specific|
29+
11. Netrw |nvim-tree-netrw|
2930

3031
==============================================================================
3132
1. INTRODUCTION *nvim-tree-introduction*
@@ -78,9 +79,11 @@ Install the plugins via your package manager:
7879
`"nvim-tree/nvim-tree.lua"`
7980
`"nvim-tree/nvim-web-devicons"`
8081

82+
Disabling |netrw| is strongly advised, see |nvim-tree-netrw|
83+
8184
Setup the plugin in your `init.lua` >
8285
83-
-- disable netrw at the very start of your init.lua (strongly advised)
86+
-- disable netrw at the very start of your init.lua
8487
vim.g.loaded_netrw = 1
8588
vim.g.loaded_netrwPlugin = 1
8689
@@ -359,7 +362,7 @@ applying configuration.
359362
glyphs = {
360363
default = "",
361364
symlink = "",
362-
bookmark = "",
365+
bookmark = "󰆤",
363366
modified = "●",
364367
folder = {
365368
arrow_closed = "",
@@ -2231,4 +2234,25 @@ Windows WSL and PowerShell
22312234
freeze nvim
22322235
- Some filesystem watcher error related to permissions will not be reported
22332236

2237+
==============================================================================
2238+
11. NETRW *nvim-tree-netrw*
2239+
2240+
|netrw| is a standard neovim plugin that is enabled by default. It provides,
2241+
amongst other functionality, a file/directory browser.
2242+
2243+
It interferes with nvim-tree and the intended user experience is nvim-tree
2244+
replacing the |netrw| browser.
2245+
2246+
It is strongly recommended to disable |netrw|. As it is a bundled plugin it
2247+
must be disabled manually at the start of your `init.lua` as per |netrw-noload|: >
2248+
2249+
vim.g.loaded_netrw = 1
2250+
vim.g.loaded_netrwPlugin = 1
2251+
<
2252+
There are many |netrw| features features beyond the file browser. If you want to
2253+
keep using |netrw| without its browser features please ensure:
2254+
2255+
|nvim-tree.disable_netrw| `= false`
2256+
|nvim-tree.hijack_netrw| ` = true`
2257+
22342258
vim:tw=78:ts=4:sw=4:et:ft=help:norl:

0 commit comments

Comments
 (0)