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

doc: clarify need for patched font for nvim-web-devicons

Browse Source
This commit is contained in:
Alexander Courtis 2022-07-09 11:14:15 +10:00
parent 22044589fe
commit 08db5a576d
2 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -23,11 +23,14 @@
[Join us on matrix](https://matrix.to/#/#nvim-tree:matrix.org) [Join us on matrix](https://matrix.to/#/#nvim-tree:matrix.org)
## Requirements
[neovim >=0.7.0](https://github.com/neovim/neovim/wiki/Installing-Neovim)
[nvim-web-devicons](https://github.com/kyazdani42/nvim-web-devicons) is optional and used to display file icons. It requires a [patched font](https://www.nerdfonts.com/)
## Install ## Install
This plugin requires [neovim >=0.7.0](https://github.com/neovim/neovim/wiki/Installing-Neovim).
Install with [vim-plug](https://github.com/junegunn/vim-plug): Install with [vim-plug](https://github.com/junegunn/vim-plug):
```vim ```vim
@ -110,6 +113,7 @@ nvim-tree comes with number of mappings; for default mappings please see [:help
* If you `:set nosplitright`, the files will open on the left side of the tree, placing the tree window in the right side of the file you opened. * If you `:set nosplitright`, the files will open on the left side of the tree, placing the tree window in the right side of the file you opened.
* You can automatically close the tab/vim when nvim-tree is the last window in the tab: <https://github.com/kyazdani42/nvim-tree.lua/discussions/1115>. WARNING: this can catastrophically fail: <https://github.com/kyazdani42/nvim-tree.lua/issues/1368>. This will not be added to nvim-tree and the team will not provide support / assistance with this, due to complexities in vim event timings and side-effects. * You can automatically close the tab/vim when nvim-tree is the last window in the tab: <https://github.com/kyazdani42/nvim-tree.lua/discussions/1115>. WARNING: this can catastrophically fail: <https://github.com/kyazdani42/nvim-tree.lua/issues/1368>. This will not be added to nvim-tree and the team will not provide support / assistance with this, due to complexities in vim event timings and side-effects.
* Hide the `.git` folder: `filters = { custom = { "^.git$" } }`. See [:help nvim-tree.filters.custom](doc/nvim-tree-lua.txt). * Hide the `.git` folder: `filters = { custom = { "^.git$" } }`. See [:help nvim-tree.filters.custom](doc/nvim-tree-lua.txt).
* To disable the display of icons see [:help nvim-tree.renderer.icons.show](https://neovim.io/doc/user/lua.html)
## Troubleshooting ## Troubleshooting

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

@ -30,11 +30,15 @@ Features
File Icons File Icons
See https://github.com/kyazdani42/nvim-web-devicons https://github.com/kyazdani42/nvim-web-devicons is optional and used to display file icons. It requires a patched font: https://www.nerdfonts.com
Requires a patched font.
 should look like an open folder.  should look like an open folder.
Syntax highlighting uses g:terminal_color_ from colorschemes, fallbacks to To disable the display of icons see |renderer.icons.show|
Colours
Syntax highlighting uses g:terminal_color_ from colorschemes, falls back to
ugly colors otherwise. ugly colors otherwise.
Git Integration Git Integration