2019-08-22 15:36:17 +00:00
|
|
|
" vim: ts=4 sw=4:
|
2018-02-04 11:35:08 +00:00
|
|
|
" folding for Markdown headers, both styles (atx- and setex-)
|
|
|
|
" http://daringfireball.net/projects/markdown/syntax#header
|
|
|
|
"
|
|
|
|
" this code can be placed in file
|
|
|
|
" $HOME/.vim/after/ftplugin/markdown.vim
|
|
|
|
"
|
|
|
|
" original version from Steve Losh's gist: https://gist.github.com/1038710
|
|
|
|
|
|
|
|
function! s:is_mkdCode(lnum)
|
|
|
|
let name = synIDattr(synID(a:lnum, 1, 0), 'name')
|
2022-08-08 13:45:56 +00:00
|
|
|
return (name =~# '^mkd\%(Code$\|Snippet\)' || name !=# '' && name !~? '^\%(mkd\|html\)')
|
2018-02-04 11:35:08 +00:00
|
|
|
endfunction
|
|
|
|
|
2022-08-08 13:45:56 +00:00
|
|
|
if get(g:, 'vim_markdown_folding_style_pythonic', 0)
|
2018-02-04 11:35:08 +00:00
|
|
|
function! Foldexpr_markdown(lnum)
|
|
|
|
let l1 = getline(a:lnum)
|
2019-08-22 15:36:17 +00:00
|
|
|
"~~~~~ keep track of fenced code blocks ~~~~~
|
|
|
|
"If we hit a code block fence
|
2022-08-08 13:45:56 +00:00
|
|
|
if l1 =~# '````*' || l1 =~# '\~\~\~\~*'
|
2019-08-22 15:36:17 +00:00
|
|
|
" toggle the variable that says if we're in a code block
|
2018-02-04 11:35:08 +00:00
|
|
|
if b:fenced_block == 0
|
|
|
|
let b:fenced_block = 1
|
|
|
|
elseif b:fenced_block == 1
|
|
|
|
let b:fenced_block = 0
|
|
|
|
endif
|
2019-08-22 15:36:17 +00:00
|
|
|
" else, if we're caring about front matter
|
2022-12-03 10:29:32 +00:00
|
|
|
elseif get(g:, 'vim_markdown_frontmatter', 0) == 1
|
2019-08-22 15:36:17 +00:00
|
|
|
" if we're in front matter and not on line 1
|
2018-02-04 11:35:08 +00:00
|
|
|
if b:front_matter == 1 && a:lnum > 2
|
|
|
|
let l0 = getline(a:lnum-1)
|
2019-08-22 15:36:17 +00:00
|
|
|
" if the previous line fenced front matter
|
2022-08-08 13:45:56 +00:00
|
|
|
if l0 ==# '---'
|
2019-08-22 15:36:17 +00:00
|
|
|
" we must not be in front matter
|
2018-02-04 11:35:08 +00:00
|
|
|
let b:front_matter = 0
|
|
|
|
endif
|
2019-08-22 15:36:17 +00:00
|
|
|
" else, if we're on line one
|
2018-02-04 11:35:08 +00:00
|
|
|
elseif a:lnum == 1
|
2019-08-22 15:36:17 +00:00
|
|
|
" if we hit a front matter fence
|
2022-08-08 13:45:56 +00:00
|
|
|
if l1 ==# '---'
|
2019-08-22 15:36:17 +00:00
|
|
|
" we're in the front matter
|
2018-02-04 11:35:08 +00:00
|
|
|
let b:front_matter = 1
|
|
|
|
endif
|
|
|
|
endif
|
|
|
|
endif
|
|
|
|
|
2019-08-22 15:36:17 +00:00
|
|
|
" if we're in a code block or front matter
|
2022-08-08 13:45:56 +00:00
|
|
|
if b:fenced_block ==# 1 || b:front_matter ==# 1
|
|
|
|
if a:lnum ==# 1
|
2018-02-04 11:35:08 +00:00
|
|
|
" fold any 'preamble'
|
|
|
|
return '>1'
|
|
|
|
else
|
|
|
|
" keep previous foldlevel
|
|
|
|
return '='
|
|
|
|
endif
|
|
|
|
endif
|
|
|
|
|
|
|
|
let l2 = getline(a:lnum+1)
|
2019-08-22 15:36:17 +00:00
|
|
|
" if the next line starts with two or more '='
|
|
|
|
" and is not code
|
2022-08-08 13:45:56 +00:00
|
|
|
if l2 =~# '^==\+\s*' && !s:is_mkdCode(a:lnum+1)
|
2018-02-04 11:35:08 +00:00
|
|
|
" next line is underlined (level 1)
|
|
|
|
return '>0'
|
2019-08-22 15:36:17 +00:00
|
|
|
" else, if the nex line starts with two or more '-'
|
2022-08-08 13:45:56 +00:00
|
|
|
" but is not comment closer (-->)
|
2019-08-22 15:36:17 +00:00
|
|
|
" and is not code
|
2022-08-08 13:45:56 +00:00
|
|
|
elseif l2 =~# '^--\+\s*$' && !s:is_mkdCode(a:lnum+1)
|
2018-02-04 11:35:08 +00:00
|
|
|
" next line is underlined (level 2)
|
|
|
|
return '>1'
|
|
|
|
endif
|
|
|
|
|
2019-08-22 15:36:17 +00:00
|
|
|
"if we're on a non-code line starting with a pound sign
|
2022-08-08 13:45:56 +00:00
|
|
|
if l1 =~# '^#' && !s:is_mkdCode(a:lnum)
|
2019-08-22 15:36:17 +00:00
|
|
|
" set the fold level to the number of hashes -1
|
|
|
|
" return '>'.(matchend(l1, '^#\+') - 1)
|
|
|
|
" set the fold level to the number of hashes
|
|
|
|
return '>'.(matchend(l1, '^#\+'))
|
|
|
|
" else, if we're on line 1
|
2018-02-04 11:35:08 +00:00
|
|
|
elseif a:lnum == 1
|
|
|
|
" fold any 'preamble'
|
|
|
|
return '>1'
|
|
|
|
else
|
|
|
|
" keep previous foldlevel
|
|
|
|
return '='
|
|
|
|
endif
|
|
|
|
endfunction
|
|
|
|
|
|
|
|
function! Foldtext_markdown()
|
|
|
|
let line = getline(v:foldstart)
|
|
|
|
let has_numbers = &number || &relativenumber
|
2022-08-08 13:45:56 +00:00
|
|
|
let nucolwidth = &foldcolumn + has_numbers * &numberwidth
|
2018-02-04 11:35:08 +00:00
|
|
|
let windowwidth = winwidth(0) - nucolwidth - 6
|
|
|
|
let foldedlinecount = v:foldend - v:foldstart
|
|
|
|
let line = strpart(line, 0, windowwidth - 2 -len(foldedlinecount))
|
|
|
|
let line = substitute(line, '\%("""\|''''''\)', '', '')
|
|
|
|
let fillcharcount = windowwidth - len(line) - len(foldedlinecount) + 1
|
2022-08-08 13:45:56 +00:00
|
|
|
return line . ' ' . repeat('-', fillcharcount) . ' ' . foldedlinecount
|
2018-02-04 11:35:08 +00:00
|
|
|
endfunction
|
2019-08-22 15:36:17 +00:00
|
|
|
else " vim_markdown_folding_style_pythonic == 0
|
2018-02-04 11:35:08 +00:00
|
|
|
function! Foldexpr_markdown(lnum)
|
|
|
|
if (a:lnum == 1)
|
|
|
|
let l0 = ''
|
|
|
|
else
|
|
|
|
let l0 = getline(a:lnum-1)
|
|
|
|
endif
|
|
|
|
|
|
|
|
" keep track of fenced code blocks
|
2022-08-08 13:45:56 +00:00
|
|
|
if l0 =~# '````*' || l0 =~# '\~\~\~\~*'
|
2018-02-04 11:35:08 +00:00
|
|
|
if b:fenced_block == 0
|
|
|
|
let b:fenced_block = 1
|
|
|
|
elseif b:fenced_block == 1
|
|
|
|
let b:fenced_block = 0
|
|
|
|
endif
|
2022-12-03 10:29:32 +00:00
|
|
|
elseif get(g:, 'vim_markdown_frontmatter', 0) == 1
|
2018-02-04 11:35:08 +00:00
|
|
|
if b:front_matter == 1
|
2022-08-08 13:45:56 +00:00
|
|
|
if l0 ==# '---'
|
2018-02-04 11:35:08 +00:00
|
|
|
let b:front_matter = 0
|
|
|
|
endif
|
|
|
|
elseif a:lnum == 2
|
2022-08-08 13:45:56 +00:00
|
|
|
if l0 ==# '---'
|
2018-02-04 11:35:08 +00:00
|
|
|
let b:front_matter = 1
|
|
|
|
endif
|
|
|
|
endif
|
|
|
|
endif
|
|
|
|
|
|
|
|
if b:fenced_block == 1 || b:front_matter == 1
|
|
|
|
" keep previous foldlevel
|
|
|
|
return '='
|
|
|
|
endif
|
|
|
|
|
|
|
|
let l2 = getline(a:lnum+1)
|
2022-08-08 13:45:56 +00:00
|
|
|
if l2 =~# '^==\+\s*' && !s:is_mkdCode(a:lnum+1)
|
2018-02-04 11:35:08 +00:00
|
|
|
" next line is underlined (level 1)
|
|
|
|
return '>1'
|
2022-08-08 13:45:56 +00:00
|
|
|
elseif l2 =~# '^--\+\s*$' && !s:is_mkdCode(a:lnum+1)
|
2018-02-04 11:35:08 +00:00
|
|
|
" next line is underlined (level 2)
|
|
|
|
if s:vim_markdown_folding_level >= 2
|
|
|
|
return '>1'
|
|
|
|
else
|
|
|
|
return '>2'
|
|
|
|
endif
|
|
|
|
endif
|
|
|
|
|
|
|
|
let l1 = getline(a:lnum)
|
2022-08-08 13:45:56 +00:00
|
|
|
if l1 =~# '^#' && !s:is_mkdCode(a:lnum)
|
2018-02-04 11:35:08 +00:00
|
|
|
" fold level according to option
|
|
|
|
if s:vim_markdown_folding_level == 1 || matchend(l1, '^#\+') > s:vim_markdown_folding_level
|
|
|
|
if a:lnum == line('$')
|
|
|
|
return matchend(l1, '^#\+') - 1
|
|
|
|
else
|
|
|
|
return -1
|
|
|
|
endif
|
|
|
|
else
|
|
|
|
" headers are not folded
|
|
|
|
return 0
|
|
|
|
endif
|
|
|
|
endif
|
|
|
|
|
2022-08-08 13:45:56 +00:00
|
|
|
if l0 =~# '^#' && !s:is_mkdCode(a:lnum-1)
|
2018-02-04 11:35:08 +00:00
|
|
|
" previous line starts with hashes
|
|
|
|
return '>'.matchend(l0, '^#\+')
|
|
|
|
else
|
|
|
|
" keep previous foldlevel
|
|
|
|
return '='
|
|
|
|
endif
|
|
|
|
endfunction
|
|
|
|
endif
|
|
|
|
|
|
|
|
|
|
|
|
let b:fenced_block = 0
|
|
|
|
let b:front_matter = 0
|
2022-08-08 13:45:56 +00:00
|
|
|
let s:vim_markdown_folding_level = get(g:, 'vim_markdown_folding_level', 1)
|
2018-02-04 11:35:08 +00:00
|
|
|
|
2019-03-27 15:08:56 +00:00
|
|
|
function! s:MarkdownSetupFolding()
|
2022-08-08 13:45:56 +00:00
|
|
|
if !get(g:, 'vim_markdown_folding_disabled', 0)
|
|
|
|
if get(g:, 'vim_markdown_folding_style_pythonic', 0)
|
|
|
|
if get(g:, 'vim_markdown_override_foldtext', 1)
|
2019-08-22 15:36:17 +00:00
|
|
|
setlocal foldtext=Foldtext_markdown()
|
|
|
|
endif
|
|
|
|
endif
|
|
|
|
setlocal foldexpr=Foldexpr_markdown(v:lnum)
|
|
|
|
setlocal foldmethod=expr
|
|
|
|
endif
|
2019-03-27 15:08:56 +00:00
|
|
|
endfunction
|
2019-08-22 15:36:17 +00:00
|
|
|
|
|
|
|
function! s:MarkdownSetupFoldLevel()
|
2022-08-08 13:45:56 +00:00
|
|
|
if get(g:, 'vim_markdown_folding_style_pythonic', 0)
|
2019-08-22 15:36:17 +00:00
|
|
|
" set default foldlevel
|
2022-08-08 13:45:56 +00:00
|
|
|
execute 'setlocal foldlevel='.s:vim_markdown_folding_level
|
2019-08-22 15:36:17 +00:00
|
|
|
endif
|
|
|
|
endfunction
|
|
|
|
|
|
|
|
call s:MarkdownSetupFoldLevel()
|
2019-03-27 15:08:56 +00:00
|
|
|
call s:MarkdownSetupFolding()
|
2019-08-22 15:36:17 +00:00
|
|
|
|
2019-03-27 15:08:56 +00:00
|
|
|
augroup Mkd
|
|
|
|
" These autocmds need to be kept in sync with the autocmds calling
|
|
|
|
" s:MarkdownRefreshSyntax in ftplugin/markdown.vim.
|
|
|
|
autocmd BufWinEnter,BufWritePost <buffer> call s:MarkdownSetupFolding()
|
|
|
|
autocmd InsertEnter,InsertLeave <buffer> call s:MarkdownSetupFolding()
|
|
|
|
autocmd CursorHold,CursorHoldI <buffer> call s:MarkdownSetupFolding()
|
|
|
|
augroup END
|