vim-markdown-toc : A plugin to generate table of contents for Markdown files.
| script karma
Downloaded by 136
Comments, bugs, improvements
script versions (upload new version)
In GitHub: https://github.com/mzlogin/vim-markdown-toc
* Generate table of contents for Markdown files.
Supported Markdown parsers:
- [x] GFM (GitHub Flavored Markdown)
- [x] Redcarpet
* Update existing table of contents.
* Auto update existing table of contents on save.
### Generate table of contents
Move the cursor to the line you want to append table of contents, then type a command below suit you. The command will generate **headings after the cursor** into table of contents.
Generate table of contents in [GFM] link style.
This command is suitable for Markdown files in GitHub repositories, like `README.md`, and Markdown files for GitBook.
Generate table of contents in [Redcarpet] link style.
This command is suitable for Jekyll or anywhere else use Redcarpet as its Markdown parser.
You can view [here] to know differences between *GFM* and *Redcarpet* style toc links.
### Update existing table of contents manually
Just use `:UpdateToc` command.
This plugin will update existing table of contents on save automatic.
You can close this feature by add the following line to your vimrc file:
let g:vmt_auto_update_on_save = 0
By default, the `:GenTocXXX` commands will add `<!-- vim-markdown-toc -->` fence to the table of contents, it is designed for feature of auto update table of contents on save, it won't effect what your Markdown file looks like after parse.
If you don't like this, you can remove the fence by add the following line to your vimrc file:
let g:vmt_dont_insert_fence = 1
But then you will lose the convenience of auto update tables of contens on save.
Suggest to manage your vim plugins via [Vundle] so you can install it simply three steps:
1. add the following line to your vimrc file
2. `:so $MYVIMRC`
Installation with [vim-plug] is likeness.
Click on the package to download.
ip used for rating: 126.96.36.199