You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[nvim-web-devicons](https://github.com/nvim-tree/nvim-web-devicons) is optional and used to display file icons. It requires a [patched font](https://www.nerdfonts.com/). Your terminal emulator must be configured to use that font, usually "Hack Nerd Font"
57
57
58
-
##Installing
58
+
# Installing
59
59
60
60
Please install via your preferred package manager. See [Installation](https://github.com/nvim-tree/nvim-tree.lua/wiki/Installation) for some specific package manager instructions.
61
61
62
62
Major or minor versions may be specified via tags: `v<MAJOR>` e.g. `v1` or `v<MAJOR>.<MINOR>` e.g. `v1.23`
63
63
64
-
##Quick Start
64
+
# Quick Start
65
65
66
66
Install the plugins via your package manager:
67
67
`"nvim-tree/nvim-tree.lua"`
68
68
`"nvim-tree/nvim-web-devicons"`
69
69
70
70
Disabling [netrw](https://neovim.io/doc/user/pi_netrw.html) is strongly advised, see [:help nvim-tree-netrw](doc/nvim-tree-lua.txt)
71
71
72
-
###Setup
72
+
## Setup
73
73
74
74
Setup the plugin in your `init.lua`.
75
75
@@ -106,13 +106,13 @@ See [:help nvim-tree-setup](doc/nvim-tree-lua.txt) and [:help nvim-tree-config-d
106
106
require("nvim-tree").setup(config)
107
107
```
108
108
109
-
###Help
109
+
## Help
110
110
111
111
Open the tree: `:NvimTreeOpen`
112
112
113
113
Show the mappings: `g?`
114
114
115
-
###Custom Mappings
115
+
## Custom Mappings
116
116
117
117
[:help nvim-tree-mappings-default](doc/nvim-tree-lua.txt) are applied by default however you may customise via [:help nvim_tree.config](doc/nvim-tree-lua.txt)`{on_attach}` e.g.
118
118
@@ -140,7 +140,7 @@ Show the mappings: `g?`
140
140
})
141
141
```
142
142
143
-
###Highlight Groups
143
+
## Highlight Groups
144
144
145
145
See [:help nvim-tree-highlight-groups](doc/nvim-tree-lua.txt)
146
146
@@ -158,7 +158,7 @@ applied at runtime. e.g.
158
158
]])
159
159
```
160
160
161
-
##Commands
161
+
# Commands
162
162
163
163
See [:help nvim-tree-commands](doc/nvim-tree-lua.txt)
164
164
@@ -200,7 +200,7 @@ Some basic commands:
200
200
})
201
201
```
202
202
203
-
##Roadmap
203
+
# Roadmap
204
204
205
205
nvim-tree is stable and new major features will not be added. The focus is on existing user experience.
206
206
@@ -214,7 +214,7 @@ Development is focused on:
214
214
- Enhancements to existing features
215
215
- Multi-instance capabilities
216
216
217
-
##API
217
+
# API
218
218
219
219
nvim-tree exposes a public API. This is non breaking, with additions made as necessary. See [:help nvim-tree-api](doc/nvim-tree-lua.txt)
220
220
@@ -224,19 +224,19 @@ Please raise a [feature request](https://github.com/nvim-tree/nvim-tree.lua/issu
224
224
225
225
You may also subscribe to events that nvim-tree will dispatch in a variety of situations, see [:help nvim-tree-events](doc/nvim-tree-lua.txt)
226
226
227
-
##Contributing
227
+
# Contributing
228
228
229
229
PRs are always welcome. See [CONTRIBUTING](CONTRIBUTING.md) and [wiki: Development](https://github.com/nvim-tree/nvim-tree.lua/wiki/Development) to get started.
230
230
231
231
See [bug](https://github.com/nvim-tree/nvim-tree.lua/issues?q=is%3Aissue+is%3Aopen+label%3Abug) and [PR Please](https://github.com/nvim-tree/nvim-tree.lua/issues?q=is%3Aopen+is%3Aissue+label%3A%22PR+please%22) issues if you are looking for some work to get you started.
232
232
233
-
##Screenshots
233
+
# Screenshots
234
234
235
235
See [Showcases](https://github.com/nvim-tree/nvim-tree.lua/wiki/Showcases) wiki page for examples of user's configurations with sources.
236
236
237
237
Please add your own!
238
238
239
-
##Team
239
+
# Team
240
240
241
241
*[@alex-courtis](https://github.com/alex-courtis) Arch Linux
0 commit comments