Vim Markdown Folding?

Question

I just realized that VIM 7.3 has built-in support for highlighting Markdown files. Excellent. However, it doesn't fold on the headings.

Can any offer suggestions on how to get this working?

Alternatively, I'm using Markdown only as a way to get simple structured text. If there is a better alternative format, please also suggest. But not sure I dig TVO or VimOutliner.

Answer 1

When I use markdown I only use the hash-style headings with space separating hashes and text. This makes the folding task a lot simpler.

I'm pretty new to Vim, so use the following at your own risk. I added the following code to my vimrc and it folds headings based on number of hashes, and it retains the syntax colouring.

function! MarkdownLevel()     if getline(v:lnum) =~ '^# .*$'         return ">1"     endif     if getline(v:lnum) =~ '^## .*$'         return ">2"     endif     if getline(v:lnum) =~ '^### .*$'         return ">3"     endif     if getline(v:lnum) =~ '^#### .*$'         return ">4"     endif     if getline(v:lnum) =~ '^##### .*$'         return ">5"     endif     if getline(v:lnum) =~ '^###### .*$'         return ">6"     endif     return "="  endfunction au BufEnter *.md setlocal foldexpr=MarkdownLevel()   au BufEnter *.md setlocal foldmethod=expr      

Answer 2

let g:markdown_folding = 1 

You can enable markdown folding feature by adding this in your .vimrc if you are using the latest version of Vim - no need to be the latest, but I don't know the exact version.

For some reason it's not documented in the README but you can find the related code in the repository.

FYI, if you don't want the sections closed when you open a file, refer to this SO thread. I think adding this would be the best way but you may have a different preference.

set nofoldenable 

Update

Unfortunately, I stopped using markdown_folding since it makes things slow (Github issue).