]> 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:

fixed "feature" to not fold level 1 headings
[etc/vim.git] / after / ftplugin / markdown.vim
index f16d875f4127f596abf75dc4aa1ddf2a061ca8f8..91139ce98f27945187a40d1017b8e280f5ae4465 100644 (file)
@@ -1,3 +1,4 @@
+" vim: ts=4:
 " folding for Markdown headers, both styles (atx- and setex-)
 " http://daringfireball.net/projects/markdown/syntax#header
 "
 " folding for Markdown headers, both styles (atx- and setex-)
 " http://daringfireball.net/projects/markdown/syntax#header
 "
@@ -14,26 +15,36 @@ endfunction
 if get(g:, "vim_markdown_folding_style_pythonic", 0)
     function! Foldexpr_markdown(lnum)
         let l1 = getline(a:lnum)
 if get(g:, "vim_markdown_folding_style_pythonic", 0)
     function! Foldexpr_markdown(lnum)
         let l1 = getline(a:lnum)
-        " keep track of fenced code blocks
+        "~~~~~ keep track of fenced code blocks ~~~~~
+               "If we hit a code block fence
         if l1 =~ '````*' || l1 =~ '\~\~\~\~*'
         if l1 =~ '````*' || l1 =~ '\~\~\~\~*'
+                       " toggle the variable that says if we're in a code block
             if b:fenced_block == 0
                 let b:fenced_block = 1
             elseif b:fenced_block == 1
                 let b:fenced_block = 0
             endif
             if b:fenced_block == 0
                 let b:fenced_block = 1
             elseif b:fenced_block == 1
                 let b:fenced_block = 0
             endif
+               " else, if we're caring about front matter
         elseif g:vim_markdown_frontmatter == 1
         elseif g:vim_markdown_frontmatter == 1
+                       " if we're in front matter and not on line 1
             if b:front_matter == 1 && a:lnum > 2
                 let l0 = getline(a:lnum-1)
             if b:front_matter == 1 && a:lnum > 2
                 let l0 = getline(a:lnum-1)
+                               " if the previous line fenced front matter
                 if l0 == '---'
                 if l0 == '---'
+                                       " we must not be in front matter
                     let b:front_matter = 0
                 endif
                     let b:front_matter = 0
                 endif
+                       " else, if we're on line one
             elseif a:lnum == 1
             elseif a:lnum == 1
+                               " if we hit a front matter fence
                 if l1 == '---'
                 if l1 == '---'
+                                       " we're in the front matter
                     let b:front_matter = 1
                 endif
             endif
         endif
 
                     let b:front_matter = 1
                 endif
             endif
         endif
 
+               " if we're in a code block or front matter
         if b:fenced_block == 1 || b:front_matter == 1
             if a:lnum == 1
                 " fold any 'preamble'
         if b:fenced_block == 1 || b:front_matter == 1
             if a:lnum == 1
                 " fold any 'preamble'
@@ -45,17 +56,25 @@ if get(g:, "vim_markdown_folding_style_pythonic", 0)
         endif
 
         let l2 = getline(a:lnum+1)
         endif
 
         let l2 = getline(a:lnum+1)
+               " if the next line starts with two or more '='
+               " and is not code
         if l2 =~ '^==\+\s*' && !s:is_mkdCode(a:lnum+1)
             " next line is underlined (level 1)
             return '>0'
         if l2 =~ '^==\+\s*' && !s:is_mkdCode(a:lnum+1)
             " next line is underlined (level 1)
             return '>0'
+               " else, if the nex line starts with two or more '-'
+               " and is not code
         elseif l2 =~ '^--\+\s*' && !s:is_mkdCode(a:lnum+1)
             " next line is underlined (level 2)
             return '>1'
         endif
 
         elseif l2 =~ '^--\+\s*' && !s:is_mkdCode(a:lnum+1)
             " next line is underlined (level 2)
             return '>1'
         endif
 
+               "if we're on a non-code line starting with a pound sign
         if l1 =~ '^#' && !s:is_mkdCode(a:lnum)
         if l1 =~ '^#' && !s:is_mkdCode(a:lnum)
-            " current line starts with hashes
-            return '>'.(matchend(l1, '^#\+') - 1)
+                       " 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
         elseif a:lnum == 1
             " fold any 'preamble'
             return '>1'
         elseif a:lnum == 1
             " fold any 'preamble'
             return '>1'
@@ -76,7 +95,7 @@ if get(g:, "vim_markdown_folding_style_pythonic", 0)
         let fillcharcount = windowwidth - len(line) - len(foldedlinecount) + 1
         return line . ' ' . repeat("-", fillcharcount) . ' ' . foldedlinecount
     endfunction
         let fillcharcount = windowwidth - len(line) - len(foldedlinecount) + 1
         return line . ' ' . repeat("-", fillcharcount) . ' ' . foldedlinecount
     endfunction
-else
+else " vim_markdown_folding_style_pythonic == 1
     function! Foldexpr_markdown(lnum)
         if (a:lnum == 1)
             let l0 = ''
     function! Foldexpr_markdown(lnum)
         if (a:lnum == 1)
             let l0 = ''
@@ -114,7 +133,7 @@ else
             return '>1'
         elseif l2 =~ '^--\+\s*' && !s:is_mkdCode(a:lnum+1)
             " next line is underlined (level 2)
             return '>1'
         elseif l2 =~ '^--\+\s*' && !s:is_mkdCode(a:lnum+1)
             " next line is underlined (level 2)
-            if g:vim_markdown_folding_level >= 2
+            if s:vim_markdown_folding_level >= 2
                 return '>1'
             else
                 return '>2'
                 return '>1'
             else
                 return '>2'
@@ -124,9 +143,12 @@ else
         let l1 = getline(a:lnum)
         if l1 =~ '^#' && !s:is_mkdCode(a:lnum)
             " fold level according to option
         let l1 = getline(a:lnum)
         if l1 =~ '^#' && !s:is_mkdCode(a:lnum)
             " fold level according to option
-            let l:level = matchend(l1, '^#\+')
-            if g:vim_markdown_folding_level == 1 || l:level > g:vim_markdown_folding_level
-                return -1
+            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
             else
                 " headers are not folded
                 return 0
@@ -134,10 +156,10 @@ else
         endif
 
         if l0 =~ '^#' && !s:is_mkdCode(a:lnum-1)
         endif
 
         if l0 =~ '^#' && !s:is_mkdCode(a:lnum-1)
-            " current line starts with hashes
+            " previous line starts with hashes
             return '>'.matchend(l0, '^#\+')
         else
             return '>'.matchend(l0, '^#\+')
         else
-            " fold here because of setext headers
+            " keep previous foldlevel
             return '='
         endif
     endfunction
             return '='
         endif
     endfunction
@@ -146,12 +168,12 @@ endif
 
 let b:fenced_block = 0
 let b:front_matter = 0
 
 let b:fenced_block = 0
 let b:front_matter = 0
-let g:vim_markdown_folding_level = get(g:, "vim_markdown_folding_level", 1)
+let s:vim_markdown_folding_level = get(g:, "vim_markdown_folding_level", 1)
 
 if !get(g:, "vim_markdown_folding_disabled", 0)
     setlocal foldexpr=Foldexpr_markdown(v:lnum)
     setlocal foldmethod=expr
 
 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)
+    if get(g:, "vim_markdown_folding_style_pythonic", 0) && get(g:, "vim_markdown_override_foldtext", 1)
         setlocal foldtext=Foldtext_markdown()
     endif
 endif
         setlocal foldtext=Foldtext_markdown()
     endif
 endif