sponsor Vim development Vim logo Vim Book Ad

tocdown : display the headlines of a markdown document in an extra window

 script karma  Rating 4/3, Downloaded by 1033  Comments, bugs, improvements  Vim wiki

created by
Matthias Guenther
script type

When you are writing a tons of documents in markdown with many headings and you want to get an overview about all the headlines you have, would it be very handy to have shortcut in Vim to simply give you a structured representation of all the heading you have in your large markdown file?

The great taglist.vim plugin solved the problem already for variables and functions of many different programming languages but not for plain markdown-files. That's why I wrote tocdown.


Simply press :TocdownToggle and the extra window with the headline of the current file will open. If you call :TocdownToggle again, the window will be closed.

When you know how you want to use this plugin, you can use a custom mapping in your |:vimrc| to toggle the toc of a md-file

nnoremap <F2> :TocdownToggle

You can change the mapping to your needs.



install details

Unzip the most recent ZIP (https://github.com/matthias-guenther/tocdown/zipball/master) archive file inside your Vim profile directory (usually ~/.vim).
The plugin is compatible with Tim Popes pathogen script https://github.com/tpope/vim-pathogen.

rate this script Life Changing Helpful Unfulfilling 
script versions (upload new version)

Click on the package to download.

package script version date Vim version user release notes
tocdown.zip 1.0.1 2012-01-21 7.0 Matthias Guenther better Ruby script, faster generation of the headline
tocdown.zip 1.0.0 2011-12-22 7.0 Matthias Guenther Initial upload
ip used for rating:

If you have questions or remarks about this site, visit the vimonline development pages. Please use this site responsibly.
Questions about Vim should go to the maillist. Help Bram help Uganda.
Vim at Github