fixed "feature" to not fold level 1 headings

I also added comments explaining some of the code in that section, for
my own benefit.

diff --git a/after/ftplugin/markdown.vim b/after/ftplugin/markdown.vim
index 9ee01006960b118c1a82ddec0958b047496e54db..91139ce98f27945187a40d1017b8e280f5ae4465 100644 (file)
--- a/after/ftplugin/markdown.vim
+++ b/after/ftplugin/markdown.vim
@@ -1,3 +1,4 @@
+" vim: ts=4:
 " 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)
-        " keep track of fenced code blocks
+        "~~~~~ keep track of fenced code blocks ~~~~~
+               "If we hit a code block fence
         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
+               " else, if we're caring about front matter
         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 the previous line fenced front matter
                 if l0 == '---'
+                                       " we must not be in front matter
                     let b:front_matter = 0
                 endif
+                       " else, if we're on line one
             elseif a:lnum == 1
+                               " if we hit a front matter fence
                 if l1 == '---'
+                                       " we're in the front matter
                     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'
@@ -45,17 +56,25 @@ if get(g:, "vim_markdown_folding_style_pythonic", 0)
         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'
+               " 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
 
+               "if we're on a non-code line starting with a pound sign
         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'
@@ -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
-else
+else " vim_markdown_folding_style_pythonic == 1
     function! Foldexpr_markdown(lnum)
         if (a:lnum == 1)
             let l0 = ''