Skip to content

Latest commit

 

History

History
103 lines (58 loc) · 2.79 KB

README.md

File metadata and controls

103 lines (58 loc) · 2.79 KB
Raw

Tocdown.vim is a Vim plugin to to display the headlines of a markdown document in an extra window.

Description

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 this plugin.

Screencast

http://www.screenr.com/zvos

Installation

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.

Usage

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.

Idea and internals

This plugin takes a markdown-file and scans for heading. According to the heading level, the output will be generated nicely intended and structured.

For example the input file is:

# I'm the header #
...

## I'm a subsection ##
...

### I'm small as a pie ###
...

# I'm simple and a second header
...

## I'm simple and a subsection
...

### I'm simple and small as a pie

The output will be written to a text-file with the following content:

I'm the header
  I'm a subsection
    I'm small as a pie
I'm simple and a second header
  I'm simple and a subsection
    I'm simple and small as a pie

This content of the text-file appears in the extra-window.

Contribute/Contact

Feature request, bugs, questions, etc. can be send to [email protected]. You can even fork this project.

Self-Promotion

Like tocdown.vim? Then follow the repository on GitHub and vote for it on vim.org. And if you're feeling especially charitable, follow wikimatze on Twitter and GitHub.

License

This software is licensed under the MIT license.

© 2011-2013 Matthias Günther [email protected]