Skip to content

Latest commit

 

History

History
55 lines (38 loc) · 1.58 KB

README.md

File metadata and controls

55 lines (38 loc) · 1.58 KB
Raw

markdown-toc.vim

Have you ever wanted to have a sweet table of contents for your markdown file but didn't want to deal with the pain of generating it yourself? Well now you dont have to.

  1. Usage
  2. Configuration
  3. Example
  4. Installation

Usage

  • Run :GenerateMarkdownTOC to generate the table of contents for an open markdown file. This will place the generated table of contents at the location of your cursor at the time that you run the command.
    • Supports both # and ==/-- styles of header declarations

Configuration

By default this plugin will not generate an entry for top level headers (# or ==). You can modifying this behavior by setting g:mdtoc_starting_header_level = 1

let g:mdtoc_starting_header_level = 1

Example

# Top level header

1. [Sub-heading](#sub-heading)
2. [Another sub heading](#another-sub-heading)
	1. [You can even mix heading styles if that floats your boat](#you-can-even-mix-heading-styles-if-that-floats-your-boat)
		1. [This is totally like inception](#this-is-totally-like-inception)

## Sub-heading
Some content will go here

Another sub heading
------------------
Some other content can go here if you want

### You can even mix heading styles if that floats your boat
Because we know you do what you want

#### This is totally like inception

Installation

You can use your favorite vim package manage but here are a few for your convenience.

" plug.vim
Plug 'ajorgensen/vim-markdown-toc'

" Vundle
Plugin 'ajorgensen/vim-markdown-toc'