Create a gist now

Instantly share code, notes, and snippets.

What would you like to do?
Markdown folding for Vim
" folding for Markdown headers, both styles (atx- and setex-)
" this code can be placed in file
" $HOME/.vim/after/ftplugin/markdown.vim
func! Foldexpr_markdown(lnum)
let l1 = getline(a:lnum)
if l1 =~ '^\s*$'
" ignore empty lines
return '='
let l2 = getline(a:lnum+1)
if l2 =~ '^==\+\s*'
" next line is underlined (level 1)
return '>1'
elseif l2 =~ '^--\+\s*'
" next line is underlined (level 2)
return '>2'
elseif l1 =~ '^#'
" current line starts with hashes
return '>'.matchend(l1, '^#\+')
elseif a:lnum == 1
" fold any 'preamble'
return '>1'
" keep previous foldlevel
return '='
setlocal foldexpr=Foldexpr_markdown(v:lnum)
setlocal foldmethod=expr
"---------- everything after this is optional -----------------------
" change the following fold options to your liking
" see ':help fold-options' for more
setlocal foldenable
setlocal foldlevel=0
setlocal foldcolumn=0

This works great in standard vim but in gui it doesn't, any ideas?

memeplex commented Aug 5, 2013

Maybe you would like to see '# hi i'm a first level header' or '## ....' etc. instead of the default fold label:

setlocal foldtext=Markdown_Foldtext()

function Markdown_Foldtext()
let l1 = getline(v:foldstart)
if l:l1[0] != '#'
return repeat('#', v:foldlevel) . ' ' . l:l1 . '...'
return l:l1 . '...'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment