A vim 7.4+ plugin to generate table of contents for Markdown files.
Table of Contents
Generate table of contents for Markdown files.
Supported Markdown parsers:
- GFM (GitHub Flavored Markdown)
Update existing table of contents.
Auto update existing table of contents on save.
Suggest to manage your vim plugins via Vundle so you can install it simply three steps:
add the following line to your vimrc file
Installation with vim-plug is likeness.
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.
Generate table of contents in GitLab link style.
This command is suitable for GitLab repository and wiki.
You can view here to know differences between GFM and Redcarpet style toc links.
Update existing table of contents
Generally you don't need to do this manually, existing table of contents will auto update on save by default.
:UpdateToc command, which is designed to update toc manually, can only work when
g:vmt_auto_update_on_save turned off, and keep insert fence.
Remove table of contents
:RemoveToc command will do this for you, just remember keep insert fence option by default.
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
:GenTocXXXcommands will add
<!-- vim-markdown-toc -->fence to the table of contents, it is designed for feature of auto update table of contents on save and
:UpdateToccommand, 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 contents on save and
:UpdateToccommand. When you want to update toc, you need to remove existing toc manually and rerun
Inner text of the fence marker for the table of contents, see
Inner text of the closing fence marker. E.g., you could
let g:vmt_fence_text = 'TOC'and
let g:vmt_fence_closing_text = '/TOC'to get
<!-- TOC --> [TOC] <!-- /TOC -->
By default, vim-markdown-toc will add the markdown style into the fence of the text for the table of contents. You can avoid this and set a default markdown style with
g:vmt_fence_hidden_markdown_stylethat is applied if a fence is found containing the
g:vmt_fence_textwithout any markdown style. Obviously,
g:vmt_fence_hidden_markdown_stylehas to be supported, i.e. currently one of
['GFM', 'Redcarpet', 'GitLab', 'Marked'].
*is used to denote every level of a list:
* [Level 1](#level-1) * [Level 1-1](#level-1-1) * [Level 1-2](#level-1-2) * [Level 1-2-1](#level-1-2-1) * [Level 2](level-2)
If you set:
let g:vmt_cycle_list_item_markers = 1
every level will instead cycle between the valid list item markers
* [Level 1](#level-1) - [Level 1-1](#level-1-1) - [Level 1-2](#level-1-2) + [Level 1-2-1](#level-1-2-1) * [Level 2](level-2)
This renders the same according to Markdown rules, but might appeal to those who care about readability of the source.
The list item marker, it can be