syntax/markdown.vim

   1 " Vim syntax file
   2 " Language:     Markdown
   3 " Maintainer:   Ben Williams <benw@plasticboy.com>
   4 " URL:          http://plasticboy.com/markdown-vim-mode/
   5 " Remark:       Uses HTML syntax file
   6 " TODO:         Handle stuff contained within stuff (e.g. headings within blockquotes)
   7
   8
   9 " Read the HTML syntax to start with
  10 if version < 600
  11   so <sfile>:p:h/html.vim
  12 else
  13   runtime! syntax/html.vim
  14
  15   if exists('b:current_syntax')
  16     unlet b:current_syntax
  17   endif
  18 endif
  19
  20 if version < 600
  21   syntax clear
  22 elseif exists("b:current_syntax")
  23   finish
  24 endif
  25
  26 " don't use standard HiLink, it will not work with included syntax files
  27 if version < 508
  28   command! -nargs=+ HtmlHiLink hi link <args>
  29 else
  30   command! -nargs=+ HtmlHiLink hi def link <args>
  31 endif
  32
  33 syn spell toplevel
  34 syn case ignore
  35 syn sync linebreaks=1
  36
  37 let s:conceal = ''
  38 let s:concealends = ''
  39 if has('conceal') && get(g:, 'vim_markdown_conceal', 1)
  40   let s:conceal = ' conceal'
  41   let s:concealends = ' concealends'
  42 endif
  43
  44 " additions to HTML groups
  45 if get(g:, 'vim_markdown_emphasis_multiline', 1)
  46     let s:oneline = ''
  47 else
  48     let s:oneline = ' oneline'
  49 endif
  50 syn region mkdItalic matchgroup=mkdItalic start="\%(\*\|_\)"    end="\%(\*\|_\)"
  51 syn region mkdBold matchgroup=mkdBold start="\%(\*\*\|__\)"    end="\%(\*\*\|__\)"
  52 syn region mkdBoldItalic matchgroup=mkdBoldItalic start="\%(\*\*\*\|___\)"    end="\%(\*\*\*\|___\)"
  53 execute 'syn region htmlItalic matchgroup=mkdItalic start="\%(^\|\s\)\zs\*\ze[^\\\*\t ]\%(\%([^*]\|\\\*\|\n\)*[^\\\*\t ]\)\?\*\_W" end="[^\\\*\t ]\zs\*\ze\_W" keepend contains=@Spell' . s:oneline . s:concealends
  54 execute 'syn region htmlItalic matchgroup=mkdItalic start="\%(^\|\s\)\zs_\ze[^\\_\t ]" end="[^\\_\t ]\zs_\ze\_W" keepend contains=@Spell' . s:oneline . s:concealends
  55 execute 'syn region htmlBold matchgroup=mkdBold start="\%(^\|\s\)\zs\*\*\ze\S" end="\S\zs\*\*" keepend contains=@Spell' . s:oneline . s:concealends
  56 execute 'syn region htmlBold matchgroup=mkdBold start="\%(^\|\s\)\zs__\ze\S" end="\S\zs__" keepend contains=@Spell' . s:oneline . s:concealends
  57 execute 'syn region htmlBoldItalic matchgroup=mkdBoldItalic start="\%(^\|\s\)\zs\*\*\*\ze\S" end="\S\zs\*\*\*" keepend contains=@Spell' . s:oneline . s:concealends
  58 execute 'syn region htmlBoldItalic matchgroup=mkdBoldItalic start="\%(^\|\s\)\zs___\ze\S" end="\S\zs___" keepend contains=@Spell' . s:oneline . s:concealends
  59
  60 " [link](URL) | [link][id] | [link][] | ![image](URL)
  61 syn region mkdFootnotes matchgroup=mkdDelimiter start="\[^"    end="\]"
  62 execute 'syn region mkdID matchgroup=mkdDelimiter    start="\["    end="\]" contained oneline' . s:conceal
  63 execute 'syn region mkdURL matchgroup=mkdDelimiter   start="("     end=")"  contained oneline' . s:conceal
  64 execute 'syn region mkdLink matchgroup=mkdDelimiter  start="\\\@<!!\?\[\ze[^]\n]*\n\?[^]\n]*\][[(]" end="\]" contains=@mkdNonListItem,@Spell nextgroup=mkdURL,mkdID skipwhite' . s:concealends
  65
  66 " Autolink without angle brackets.
  67 " mkd  inline links:      protocol     optional  user:pass@  sub/domain                    .com, .co.uk, etc         optional port   path/querystring/hash fragment
  68 "                         ------------ _____________________ ----------------------------- _________________________ ----------------- __
  69 syn match   mkdInlineURL /https\?:\/\/\(\w\+\(:\w\+\)\?@\)\?\([A-Za-z0-9][-_0-9A-Za-z]*\.\)\{1,}\(\w\{2,}\.\?\)\{1,}\(:[0-9]\{1,5}\)\?\S*/
  70
  71 " Autolink with parenthesis.
  72 syn region  mkdInlineURL matchgroup=mkdDelimiter start="(\(https\?:\/\/\(\w\+\(:\w\+\)\?@\)\?\([A-Za-z0-9][-_0-9A-Za-z]*\.\)\{1,}\(\w\{2,}\.\?\)\{1,}\(:[0-9]\{1,5}\)\?\S*)\)\@=" end=")"
  73
  74 " Autolink with angle brackets.
  75 syn region mkdInlineURL matchgroup=mkdDelimiter start="\\\@<!<\ze[a-z][a-z0-9,.-]\{1,22}:\/\/[^> ]*>" end=">"
  76
  77 " Link definitions: [id]: URL (Optional Title)
  78 syn region mkdLinkDef matchgroup=mkdDelimiter   start="^ \{,3}\zs\[\^\@!" end="]:" oneline nextgroup=mkdLinkDefTarget skipwhite
  79 syn region mkdLinkDefTarget start="<\?\zs\S" excludenl end="\ze[>[:space:]\n]"   contained nextgroup=mkdLinkTitle,mkdLinkDef skipwhite skipnl oneline
  80 syn region mkdLinkTitle matchgroup=mkdDelimiter start=+"+     end=+"+  contained
  81 syn region mkdLinkTitle matchgroup=mkdDelimiter start=+'+     end=+'+  contained
  82 syn region mkdLinkTitle matchgroup=mkdDelimiter start=+(+     end=+)+  contained
  83
  84 "HTML headings
  85 syn region htmlH1       start="^\s*#"                   end="$" contains=mkdLink,mkdInlineURL,@Spell
  86 syn region htmlH2       start="^\s*##"                  end="$" contains=mkdLink,mkdInlineURL,@Spell
  87 syn region htmlH3       start="^\s*###"                 end="$" contains=mkdLink,mkdInlineURL,@Spell
  88 syn region htmlH4       start="^\s*####"                end="$" contains=mkdLink,mkdInlineURL,@Spell
  89 syn region htmlH5       start="^\s*#####"               end="$" contains=mkdLink,mkdInlineURL,@Spell
  90 syn region htmlH6       start="^\s*######"              end="$" contains=mkdLink,mkdInlineURL,@Spell
  91 syn match  htmlH1       /^.\+\n=\+$/ contains=mkdLink,mkdInlineURL,@Spell
  92 syn match  htmlH2       /^.\+\n-\+$/ contains=mkdLink,mkdInlineURL,@Spell
  93
  94 "define Markdown groups
  95 syn match  mkdLineBreak    /  \+$/
  96 syn region mkdBlockquote   start=/^\s*>/                   end=/$/ contains=mkdLink,mkdInlineURL,mkdLineBreak,@Spell
  97 syn region mkdCode         start=/\(\([^\\]\|^\)\\\)\@<!`/ end=/\(\([^\\]\|^\)\\\)\@<!`/
  98 syn region mkdCode         start=/\s*``[^`]*/              end=/[^`]*``\s*/
  99 syn region mkdCode         start=/^\s*\z(`\{3,}\)[^`]*$/   end=/^\s*\z1`*\s*$/
 100 syn region mkdCode         start=/\s*\~\~[^\~]*/           end=/[^\~]*\~\~\s*/
 101 syn region mkdCode         start=/^\s*\z(\~\{3,}\)\s*[0-9A-Za-z_+-]*\s*$/         end=/^\s*\z1\~*\s*$/
 102 syn region mkdCode         start="<pre[^>]*\\\@<!>"        end="</pre>"
 103 syn region mkdCode         start="<code[^>]*\\\@<!>"       end="</code>"
 104 syn region mkdFootnote     start="\[^"                     end="\]"
 105 syn match  mkdCode         /^\s*\n\(\(\s\{8,}[^ ]\|\t\t\+[^\t]\).*\n\)\+/
 106 syn match  mkdCode         /\%^\(\(\s\{4,}[^ ]\|\t\+[^\t]\).*\n\)\+/
 107 syn match  mkdCode         /^\s*\n\(\(\s\{4,}[^ ]\|\t\+[^\t]\).*\n\)\+/ contained
 108 syn match  mkdListItem     /^\s*\%([-*+]\|\d\+\.\)\ze\s\+/ contained
 109 syn region mkdListItemLine start="^\s*\%([-*+]\|\d\+\.\)\s\+" end="$" oneline contains=@mkdNonListItem,mkdListItem,@Spell
 110 syn region mkdNonListItemBlock start="\(\%^\(\s*\([-*+]\|\d\+\.\)\s\+\)\@!\|\n\(\_^\_$\|\s\{4,}[^ ]\|\t+[^\t]\)\@!\)" end="^\(\s*\([-*+]\|\d\+\.\)\s\+\)\@=" contains=@mkdNonListItem,@Spell
 111 syn match  mkdRule         /^\s*\*\s\{0,1}\*\s\{0,1}\*\(\*\|\s\)*$/
 112 syn match  mkdRule         /^\s*-\s\{0,1}-\s\{0,1}-\(-\|\s\)*$/
 113 syn match  mkdRule         /^\s*_\s\{0,1}_\s\{0,1}_\(_\|\s\)*$/
 114
 115 " YAML frontmatter
 116 if get(g:, 'vim_markdown_frontmatter', 0)
 117   syn include @yamlTop syntax/yaml.vim
 118   syn region Comment matchgroup=mkdDelimiter start="\%^---$" end="^---$" contains=@yamlTop keepend
 119   unlet! b:current_syntax
 120 endif
 121
 122 if get(g:, 'vim_markdown_toml_frontmatter', 0)
 123   try
 124     syn include @tomlTop syntax/toml.vim
 125     syn region Comment matchgroup=mkdDelimiter start="\%^+++$" end="^+++$" transparent contains=@tomlTop keepend
 126     unlet! b:current_syntax
 127   catch /E484/
 128     syn region Comment matchgroup=mkdDelimiter start="\%^+++$" end="^+++$"
 129   endtry
 130 endif
 131
 132 if get(g:, 'vim_markdown_json_frontmatter', 0)
 133   try
 134     syn include @jsonTop syntax/json.vim
 135     syn region Comment matchgroup=mkdDelimiter start="\%^{$" end="^}$" contains=@jsonTop keepend
 136     unlet! b:current_syntax
 137   catch /E484/
 138     syn region Comment matchgroup=mkdDelimiter start="\%^{$" end="^}$"
 139   endtry
 140 endif
 141
 142 if get(g:, 'vim_markdown_math', 0)
 143   syn include @tex syntax/tex.vim
 144   syn region mkdMath start="\\\@<!\$" end="\$" skip="\\\$" contains=@tex keepend
 145   syn region mkdMath start="\\\@<!\$\$" end="\$\$" skip="\\\$" contains=@tex keepend
 146 endif
 147
 148 " Strike through
 149 if get(g:, 'vim_markdown_strikethrough', 0)
 150     syn region mkdStrike matchgroup=mkdStrike start="\%(\~\~\)"    end="\%(\~\~\)"
 151     HtmlHiLink mkdStrike        htmlStrike
 152 endif
 153
 154 syn cluster mkdNonListItem contains=@htmlTop,htmlItalic,htmlBold,htmlBoldItalic,mkdFootnotes,mkdInlineURL,mkdLink,mkdLinkDef,mkdLineBreak,mkdBlockquote,mkdCode,mkdRule,htmlH1,htmlH2,htmlH3,htmlH4,htmlH5,htmlH6,mkdMath
 155
 156 "highlighting for Markdown groups
 157 HtmlHiLink mkdString        String
 158 HtmlHiLink mkdCode          String
 159 HtmlHiLink mkdCodeStart     String
 160 HtmlHiLink mkdCodeEnd       String
 161 HtmlHiLink mkdFootnote      Comment
 162 HtmlHiLink mkdBlockquote    Comment
 163 HtmlHiLink mkdListItem      Identifier
 164 HtmlHiLink mkdRule          Identifier
 165 HtmlHiLink mkdLineBreak     Visual
 166 HtmlHiLink mkdFootnotes     htmlLink
 167 HtmlHiLink mkdLink          htmlLink
 168 HtmlHiLink mkdURL           htmlString
 169 HtmlHiLink mkdInlineURL     htmlLink
 170 HtmlHiLink mkdID            Identifier
 171 HtmlHiLink mkdLinkDef       mkdID
 172 HtmlHiLink mkdLinkDefTarget mkdURL
 173 HtmlHiLink mkdLinkTitle     htmlString
 174 HtmlHiLink mkdDelimiter     Delimiter
 175
 176 let b:current_syntax = "mkd"
 177
 178 delcommand HtmlHiLink
 179 " vim: ts=8