Update doc

[etc/vim.git] / ftplugin / markdown.vim

diff --git a/ftplugin/markdown.vim b/ftplugin/markdown.vim
index 61fdab4ea92cb99483be1ab7bb65a56c6b90acda..ae81c804c0d8030748917454ecdd8764be90166f 100644 (file)
--- a/ftplugin/markdown.vim
+++ b/ftplugin/markdown.vim
@@ -307,6 +307,7 @@ function! s:Toc(...)
     let b:fenced_block = 0
     let b:header_list = []
     let l:header_max_len = 0
     let b:fenced_block = 0
     let b:header_list = []
     let l:header_max_len = 0

+    let g:vim_markdown_toc_autofit = get(g:, "vim_markdown_toc_autofit", 0)

     for i in range(1, line('$'))
         let l:lineraw = getline(i)
         let l:l1 = getline(i+1)
     for i in range(1, line('$'))
         let l:lineraw = getline(i)
         let l:l1 = getline(i+1)


@@ -318,7 +319,7 @@ function! s:Toc(...)
                 let b:fenced_block = 0
             endif
         endif
                 let b:fenced_block = 0
             endif
         endif

-        if l:line =~ '^#\+' || l:l1 =~ '^==\+\s*' || l:l1 =~ '^--\+\s*'
+        if l:line =~ '^#\+' || (l:l1 =~ '^=\+\s*$' || l:l1 =~ '^-\+\s*$') && l:line =~ '^\S'

             let b:is_header = 1
         else
             let b:is_header = 0
             let b:is_header = 1
         else
             let b:is_header = 0


@@ -327,6 +328,11 @@ function! s:Toc(...)
             " append line to location list
             let b:item = {'lnum': i, 'text': l:line, 'valid': 1, 'bufnr': b:bufnr, 'col': 1}
             let b:header_list = b:header_list + [b:item]
             " append line to location list
             let b:item = {'lnum': i, 'text': l:line, 'valid': 1, 'bufnr': b:bufnr, 'col': 1}
             let b:header_list = b:header_list + [b:item]

+            " keep track of the longest header size (heading level + title)
+            let b:total_len = stridx(l:line, ' ') + len(l:line)
+            if b:total_len > l:header_max_len
+                let l:header_max_len = b:total_len
+            endif

         endif
     endfor
     if len(b:header_list) == 0
         endif
     endfor
     if len(b:header_list) == 0


@@ -339,7 +345,12 @@ function! s:Toc(...)
         lopen
     elseif l:window_type ==# 'vertical'
         vertical lopen
         lopen
     elseif l:window_type ==# 'vertical'
         vertical lopen

-        let &winwidth=(&columns/2)
+        " auto-fit toc window when possible to shrink it
+        if (&columns/2) > l:header_max_len && g:vim_markdown_toc_autofit == 1
+            let &winwidth = (l:header_max_len + 1)
+        else
+            let &winwidth = (&columns/2)
+        endif

     elseif l:window_type ==# 'tab'
         tab lopen
     else
     elseif l:window_type ==# 'tab'
         tab lopen
     else


@@ -356,7 +367,7 @@ function! s:Toc(...)
             let d.text = substitute(d.text, '\v[ ]*#*$', '', '')
         " setex headers
         else
             let d.text = substitute(d.text, '\v[ ]*#*$', '', '')
         " setex headers
         else

-            let l:next_line = getbufline(bufname(d.bufnr), d.lnum+1)
+            let l:next_line = getbufline(d.bufnr, d.lnum+1)

             if match(l:next_line, "=") > -1
                 let l:level = 0
             elseif match(l:next_line, "-") > -1
             if match(l:next_line, "=") > -1
                 let l:level = 0
             elseif match(l:next_line, "-") > -1


@@ -579,3 +590,84 @@ command! -buffer Toc call s:Toc()
 command! -buffer Toch call s:Toc('horizontal')
 command! -buffer Tocv call s:Toc('vertical')
 command! -buffer Toct call s:Toc('tab')
 command! -buffer Toch call s:Toc('horizontal')
 command! -buffer Tocv call s:Toc('vertical')
 command! -buffer Toct call s:Toc('tab')

+
+" Heavily based on vim-notes - http://peterodding.com/code/vim/notes/
+let s:filetype_dict = {
+    \ 'c++': 'cpp',
+    \ 'viml': 'vim'
+\ }
+
+function! s:Markdown_highlight_sources(force)
+    " Syntax highlight source code embedded in notes.
+    " Look for code blocks in the current file
+    let filetypes = {}
+    for line in getline(1, '$')
+        let ft = matchstr(line, '```\zs[0-9A-Za-z_+-]*')
+        if !empty(ft) && ft !~ '^\d*$' | let filetypes[ft] = 1 | endif
+    endfor
+    if !exists('b:mkd_known_filetypes')
+        let b:mkd_known_filetypes = {}
+    endif
+    if !a:force && (b:mkd_known_filetypes == filetypes || empty(filetypes))
+        return
+    endif
+
+    " Now we're ready to actually highlight the code blocks.
+    let startgroup = 'mkdCodeStart'
+    let endgroup = 'mkdCodeEnd'
+    for ft in keys(filetypes)
+        if a:force || !has_key(b:mkd_known_filetypes, ft)
+            if has_key(s:filetype_dict, ft)
+                let filetype = s:filetype_dict[ft]
+            else
+                let filetype = ft
+            endif
+            let group = 'mkdSnippet' . toupper(substitute(filetype, "[+-]", "_", "g"))
+            let include = s:syntax_include(filetype)
+            let command = 'syntax region %s matchgroup=%s start="^\s*```%s$" matchgroup=%s end="\s*```$" keepend contains=%s%s'
+            execute printf(command, group, startgroup, ft, endgroup, include, has('conceal') ? ' concealends' : '')
+            execute printf('syntax cluster mkdNonListItem add=%s', group)
+
+            let b:mkd_known_filetypes[ft] = 1
+        endif
+    endfor
+endfunction
+
+function! s:syntax_include(filetype)
+    " Include the syntax highlighting of another {filetype}.
+    let grouplistname = '@' . toupper(a:filetype)
+    " Unset the name of the current syntax while including the other syntax
+    " because some syntax scripts do nothing when "b:current_syntax" is set
+    if exists('b:current_syntax')
+        let syntax_save = b:current_syntax
+        unlet b:current_syntax
+    endif
+    try
+        execute 'syntax include' grouplistname 'syntax/' . a:filetype . '.vim'
+        execute 'syntax include' grouplistname 'after/syntax/' . a:filetype . '.vim'
+    catch /E484/
+        " Ignore missing scripts
+    endtry
+    " Restore the name of the current syntax
+    if exists('syntax_save')
+        let b:current_syntax = syntax_save
+    elseif exists('b:current_syntax')
+        unlet b:current_syntax
+    endif
+    return grouplistname
+endfunction
+
+
+function! s:Markdown_refresh_syntax(force)
+    if &filetype == 'markdown' && line('$') > 1
+        call s:Markdown_highlight_sources(a:force)
+    endif
+endfunction
+
+augroup Mkd
+    autocmd!
+    au BufWinEnter * call s:Markdown_refresh_syntax(1)
+    au BufWritePost * call s:Markdown_refresh_syntax(0)
+    au InsertEnter,InsertLeave * call s:Markdown_refresh_syntax(0)
+    au CursorHold,CursorHoldI * call s:Markdown_refresh_syntax(0)
+augroup END