]> git.madduck.net Git - etc/vim.git/blobdiff - after/ftplugin/markdown.vim

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Merge pull request #434 from yous/variables-doc
[etc/vim.git] / after / ftplugin / markdown.vim
index e635f6d1967b06b09248035204f535b896a63165..41dfd944e971a2c20ee44eea1e467b689df35457 100644 (file)
@@ -6,28 +6,54 @@
 "
 " original version from Steve Losh's gist: https://gist.github.com/1038710
 
-func! s:is_mkdCode(lnum)
-    return synIDattr(synID(a:lnum, 1, 0), 'name') == 'mkdCode'
-endfunc
-
-func! s:effective_line(lnum)
-    let line = getline(a:lnum)
-    return (line !~ '^[=-#]' || s:is_mkdCode(a:lnum)) ? '' : line
-endfunc
+function! s:is_mkdCode(lnum)
+    let name = synIDattr(synID(a:lnum, 1, 0), 'name')
+    return (name =~ '^mkd\%(Code$\|Snippet\)' || name != '' && name !~ '^\%(mkd\|html\)')
+endfunction
 
 if get(g:, "vim_markdown_folding_style_pythonic", 0)
-    func! Foldexpr_markdown(lnum)
-        let l2 = s:effective_line(a:lnum+1)
-        if  l2 =~ '^==\+\s*'
+    function! Foldexpr_markdown(lnum)
+        let l1 = getline(a:lnum)
+        " keep track of fenced code blocks
+        if l1 =~ '````*' || l1 =~ '\~\~\~\~*'
+            if b:fenced_block == 0
+                let b:fenced_block = 1
+            elseif b:fenced_block == 1
+                let b:fenced_block = 0
+            endif
+        elseif g:vim_markdown_frontmatter == 1
+            if b:front_matter == 1 && a:lnum > 2
+                let l0 = getline(a:lnum-1)
+                if l0 == '---'
+                    let b:front_matter = 0
+                endif
+            elseif a:lnum == 1
+                if l1 == '---'
+                    let b:front_matter = 1
+                endif
+            endif
+        endif
+
+        if b:fenced_block == 1 || b:front_matter == 1
+            if a:lnum == 1
+                " fold any 'preamble'
+                return '>1'
+            else
+                " keep previous foldlevel
+                return '='
+            endif
+        endif
+
+        let l2 = getline(a:lnum+1)
+        if l2 =~ '^==\+\s*' && !s:is_mkdCode(a:lnum+1)
             " next line is underlined (level 1)
             return '>0'
-        elseif l2 =~ '^--\+\s*'
+        elseif l2 =~ '^--\+\s*' && !s:is_mkdCode(a:lnum+1)
             " next line is underlined (level 2)
             return '>1'
         endif
 
-        let l1 = s:effective_line(a:lnum)
-        if l1 =~ '^#'
+        if l1 =~ '^#' && !s:is_mkdCode(a:lnum)
             " current line starts with hashes
             return '>'.(matchend(l1, '^#\+') - 1)
         elseif a:lnum == 1
@@ -37,9 +63,9 @@ if get(g:, "vim_markdown_folding_style_pythonic", 0)
             " keep previous foldlevel
             return '='
         endif
-    endfunc
+    endfunction
 
-    fun! Foldtext_markdown()
+    function! Foldtext_markdown()
         let line = getline(v:foldstart)
         let has_numbers = &number || &relativenumber
         let nucolwidth = &fdc + has_numbers * &numberwidth
@@ -49,43 +75,96 @@ if get(g:, "vim_markdown_folding_style_pythonic", 0)
         let line = substitute(line, '\%("""\|''''''\)', '', '')
         let fillcharcount = windowwidth - len(line) - len(foldedlinecount) + 1
         return line . ' ' . repeat("-", fillcharcount) . ' ' . foldedlinecount
-    endfunc
+    endfunction
 else
-    func! Foldexpr_markdown(lnum)
-        let l2 = s:effective_line(a:lnum+1)
-        if  l2 =~ '^==\+\s*'
+    function! Foldexpr_markdown(lnum)
+        if (a:lnum == 1)
+            let l0 = ''
+        else
+            let l0 = getline(a:lnum-1)
+        endif
+
+        " keep track of fenced code blocks
+        if l0 =~ '````*' || l0 =~ '\~\~\~\~*'
+            if b:fenced_block == 0
+                let b:fenced_block = 1
+            elseif b:fenced_block == 1
+                let b:fenced_block = 0
+            endif
+        elseif g:vim_markdown_frontmatter == 1
+            if b:front_matter == 1
+                if l0 == '---'
+                    let b:front_matter = 0
+                endif
+            elseif a:lnum == 2
+                if l0 == '---'
+                    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)
+        if  l2 =~ '^==\+\s*' && !s:is_mkdCode(a:lnum+1)
             " next line is underlined (level 1)
             return '>1'
-        elseif l2 =~ '^--\+\s*'
+        elseif l2 =~ '^--\+\s*' && !s:is_mkdCode(a:lnum+1)
             " next line is underlined (level 2)
-            return '>2'
+            if s:vim_markdown_folding_level >= 2
+                return '>1'
+            else
+                return '>2'
+            endif
         endif
 
-        let l1 = s:effective_line(a:lnum)
-        if l1 =~ '^#'
-            " don't include the section title in the fold
-            return '-1'
+        let l1 = getline(a:lnum)
+        if l1 =~ '^#' && !s:is_mkdCode(a:lnum)
+            " 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
 
-        if (a:lnum == 1)
-            let l0 = ''
-        else
-            let l0 = s:effective_line(a:lnum-1)
-        endif
-        if l0 =~ '^#'
-            " current line starts with hashes
+        if l0 =~ '^#' && !s:is_mkdCode(a:lnum-1)
+            " previous line starts with hashes
             return '>'.matchend(l0, '^#\+')
         else
             " keep previous foldlevel
             return '='
         endif
-    endfunc
+    endfunction
 endif
 
-if !get(g:, "vim_markdown_folding_disabled", 0)
-    setlocal foldexpr=Foldexpr_markdown(v:lnum)
-    setlocal foldmethod=expr
-    if get(g:, "vim_markdown_folding_style_pythonic", 0)
-        setlocal foldtext=Foldtext_markdown()
-    endif
-endif
+
+let b:fenced_block = 0
+let b:front_matter = 0
+let s:vim_markdown_folding_level = get(g:, "vim_markdown_folding_level", 1)
+
+function! s:MarkdownSetupFolding()
+  if !get(g:, "vim_markdown_folding_disabled", 0)
+      setlocal foldexpr=Foldexpr_markdown(v:lnum)
+      setlocal foldmethod=expr
+      if get(g:, "vim_markdown_folding_style_pythonic", 0) && get(g:, "vim_markdown_override_foldtext", 1)
+          setlocal foldtext=Foldtext_markdown()
+      endif
+  endif
+endfunction
+call s:MarkdownSetupFolding()
+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