Skip to content

Commit c076f3f

Browse files
committed
docs(#3088): test a readme toc
1 parent 6cf83d7 commit c076f3f

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -49,27 +49,27 @@ markdown-toc --maxdepth=2 -i README.md
4949

5050
<!-- tocstop -->
5151

52-
## Requirements
52+
# Requirements
5353

5454
[neovim >=0.9.0](https://github.com/neovim/neovim/wiki/Installing-Neovim)
5555

5656
[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"
5757

58-
## Installing
58+
# Installing
5959

6060
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.
6161

6262
Major or minor versions may be specified via tags: `v<MAJOR>` e.g. `v1` or `v<MAJOR>.<MINOR>` e.g. `v1.23`
6363

64-
## Quick Start
64+
# Quick Start
6565

6666
Install the plugins via your package manager:
6767
`"nvim-tree/nvim-tree.lua"`
6868
`"nvim-tree/nvim-web-devicons"`
6969

7070
Disabling [netrw](https://neovim.io/doc/user/pi_netrw.html) is strongly advised, see [:help nvim-tree-netrw](doc/nvim-tree-lua.txt)
7171

72-
### Setup
72+
## Setup
7373

7474
Setup the plugin in your `init.lua`.
7575

@@ -106,13 +106,13 @@ See [:help nvim-tree-setup](doc/nvim-tree-lua.txt) and [:help nvim-tree-config-d
106106
require("nvim-tree").setup(config)
107107
```
108108

109-
### Help
109+
## Help
110110

111111
Open the tree: `:NvimTreeOpen`
112112

113113
Show the mappings: `g?`
114114

115-
### Custom Mappings
115+
## Custom Mappings
116116

117117
[: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.
118118

@@ -140,7 +140,7 @@ Show the mappings: `g?`
140140
})
141141
```
142142

143-
### Highlight Groups
143+
## Highlight Groups
144144

145145
See [:help nvim-tree-highlight-groups](doc/nvim-tree-lua.txt)
146146

@@ -158,7 +158,7 @@ applied at runtime. e.g.
158158
]])
159159
```
160160

161-
## Commands
161+
# Commands
162162

163163
See [:help nvim-tree-commands](doc/nvim-tree-lua.txt)
164164

@@ -200,7 +200,7 @@ Some basic commands:
200200
})
201201
```
202202

203-
## Roadmap
203+
# Roadmap
204204

205205
nvim-tree is stable and new major features will not be added. The focus is on existing user experience.
206206

@@ -214,7 +214,7 @@ Development is focused on:
214214
- Enhancements to existing features
215215
- Multi-instance capabilities
216216

217-
## API
217+
# API
218218

219219
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)
220220

@@ -224,19 +224,19 @@ Please raise a [feature request](https://github.com/nvim-tree/nvim-tree.lua/issu
224224

225225
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)
226226

227-
## Contributing
227+
# Contributing
228228

229229
PRs are always welcome. See [CONTRIBUTING](CONTRIBUTING.md) and [wiki: Development](https://github.com/nvim-tree/nvim-tree.lua/wiki/Development) to get started.
230230

231231
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.
232232

233-
## Screenshots
233+
# Screenshots
234234

235235
See [Showcases](https://github.com/nvim-tree/nvim-tree.lua/wiki/Showcases) wiki page for examples of user's configurations with sources.
236236

237237
Please add your own!
238238

239-
## Team
239+
# Team
240240

241241
* [@alex-courtis](https://github.com/alex-courtis) Arch Linux
242242
* [@gegoune](https://github.com/gegoune) macOS

0 commit comments

Comments
 (0)