Skip to content

Commit 3f1daea

Browse files
committed
Adjust heading levels in README
1 parent 9b4ecd1 commit 3f1daea

File tree

2 files changed

+75
-86
lines changed

2 files changed

+75
-86
lines changed

README.md

+23-27
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ A minimalist Vim plugin manager.
3030

3131
<img src="https://raw.githubusercontent.com/junegunn/i/master/vim-plug/installer.gif" height="450">
3232

33-
### Pros.
33+
## Pros.
3434

3535
- Minimalist design
3636
- Just one file with no dependencies. Super easy to set up.
@@ -49,17 +49,17 @@ A minimalist Vim plugin manager.
4949
[40/4]: https://raw.githubusercontent.com/junegunn/i/master/vim-plug/40-in-4.gif
5050
[startup-time]: https://github.com/junegunn/vim-startuptime-benchmark#result
5151

52-
### Installation
52+
## Installation
5353

5454
[Download plug.vim](https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim)
5555
and put it in the "autoload" directory.
5656

5757
<details>
5858
<summary>Click to see the instructions</summary>
5959

60-
#### Vim
60+
### Vim
6161

62-
###### Unix
62+
#### Unix
6363

6464
```sh
6565
curl -fLo ~/.vim/autoload/plug.vim --create-dirs \
@@ -71,30 +71,30 @@ file as suggested [here][auto].
7171

7272
[auto]: https://github.com/junegunn/vim-plug/wiki/tips#automatic-installation
7373

74-
###### Windows (PowerShell)
74+
#### Windows (PowerShell)
7575

7676
```powershell
7777
iwr -useb https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim |`
7878
ni $HOME/vimfiles/autoload/plug.vim -Force
7979
```
8080

81-
#### Neovim
81+
### Neovim
8282

83-
###### Unix, Linux
83+
#### Unix, Linux
8484

8585
```sh
8686
sh -c 'curl -fLo "${XDG_DATA_HOME:-$HOME/.local/share}"/nvim/site/autoload/plug.vim --create-dirs \
8787
https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim'
8888
```
8989

90-
###### Linux (Flatpak)
90+
#### Linux (Flatpak)
9191

9292
```sh
9393
curl -fLo ~/.var/app/io.neovim.nvim/data/nvim/site/autoload/plug.vim --create-dirs \
9494
https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
9595
```
9696

97-
###### Windows (PowerShell)
97+
#### Windows (PowerShell)
9898

9999
```powershell
100100
iwr -useb https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim |`
@@ -103,7 +103,7 @@ iwr -useb https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim |`
103103

104104
</details>
105105

106-
### Usage
106+
## Usage
107107

108108
Add a vim-plug section to your `~/.vimrc` (or `init.vim` for Neovim)
109109

@@ -133,7 +133,7 @@ Reload the file or restart Vim, then you can,
133133
> document is for advanced users who want to know more about the features and
134134
> options.
135135
136-
#### Getting Help
136+
### Getting Help
137137

138138
- See [tutorial] page to learn more about the basics of vim-plug
139139
- See [tips] and [FAQ] pages for common problems and questions
@@ -142,11 +142,11 @@ Reload the file or restart Vim, then you can,
142142
[tips]: https://github.com/junegunn/vim-plug/wiki/tips
143143
[FAQ]: https://github.com/junegunn/vim-plug/wiki/faq
144144

145-
### More examples
145+
## Examples
146146

147147
The following examples demonstrate the additional features of vim-plug.
148148

149-
#### Vim script example
149+
### Vim script example
150150

151151
```vim
152152
call plug#begin()
@@ -201,7 +201,7 @@ call plug#end()
201201
" syntax off " Disable syntax highlighting
202202
```
203203

204-
#### Lua configuration example for Neovim
204+
### Lua example for Neovim
205205

206206
In Neovim, you can write your configuration in a Lua script file named
207207
`init.lua`. The following code is the Lua script equivalent to the Vim script
@@ -251,11 +251,7 @@ Plug('~/my-prototype-plugin')
251251
vim.call('plug#end')
252252
```
253253

254-
More examples can be found in:
255-
256-
* https://gitlab.com/sultanahamer/dotfiles/-/blob/master/nvim/lua/plugins.lua?ref_type=heads
257-
258-
### Commands
254+
## Commands
259255

260256
| Command | Description |
261257
| ----------------------------------- | ------------------------------------------------------------------ |
@@ -267,7 +263,7 @@ More examples can be found in:
267263
| `PlugDiff` | Examine changes from the previous update and the pending changes |
268264
| `PlugSnapshot[!] [output path]` | Generate script for restoring the current snapshot of the plugins |
269265

270-
### `Plug` options
266+
## `Plug` options
271267

272268
| Option | Description |
273269
| ----------------------- | ----------------------------------------------------------- |
@@ -280,7 +276,7 @@ More examples can be found in:
280276
| `for` | On-demand loading: File types |
281277
| `frozen` | Do not remove and do not update unless explicitly specified |
282278

283-
### Global options
279+
## Global options
284280

285281
| Flag | Default | Description |
286282
| ------------------- | --------------------------------- | ------------------------------------------------------ |
@@ -293,7 +289,7 @@ More examples can be found in:
293289
| `g:plug_url_format` | `https://git::@github.com/%s.git` | `printf` format to build repo URL (Only applies to the subsequent `Plug` commands) |
294290

295291

296-
### Keybindings
292+
## Keybindings
297293

298294
- `D` - `PlugDiff`
299295
- `S` - `PlugStatus`
@@ -305,7 +301,7 @@ More examples can be found in:
305301
- `:PlugDiff`
306302
- `X` - Revert the update
307303

308-
### Post-update hooks
304+
## Post-update hooks
309305

310306
There are some plugins that require extra steps after installation or update.
311307
In that case, use the `do` option to describe the task to be performed.
@@ -365,7 +361,7 @@ with the bang-versions of the commands: `PlugInstall!` and `PlugUpdate!`.
365361
> Plug 'junegunn/fzf', { 'do': g:fzf_install }
366362
> ```
367363
368-
#### `PlugInstall!` and `PlugUpdate!`
364+
### `PlugInstall!` and `PlugUpdate!`
369365
370366
The installer takes the following steps when installing/updating a plugin:
371367
@@ -377,7 +373,7 @@ The installer takes the following steps when installing/updating a plugin:
377373
378374
The commands with the `!` suffix ensure that all steps are run unconditionally.
379375
380-
### On-demand loading of plugins
376+
## On-demand loading of plugins
381377
382378
```vim
383379
" NERD tree will be loaded on the first invocation of NERDTreeToggle command
@@ -437,11 +433,11 @@ autocmd! User goyo.vim echom 'Goyo is now loaded!'
437433
> See https://github.com/junegunn/vim-plug/wiki/tips#loading-plugins-manually
438434
439435
440-
### Collaborators
436+
## Collaborators
441437
442438
- [Jan Edmund Lazo](https://github.com/janlazo) - Windows support
443439
- [Jeremy Pallats](https://github.com/starcraftman) - Python installer
444440
445-
### License
441+
## License
446442
447443
MIT

0 commit comments

Comments
 (0)