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')
  40   let s:conceal = ' conceal'
  41   let s:concealends = ' concealends'
  42 endif
  43
  44 "additions to HTML groups
  45 syn region htmlItalic start="\%(^\|\s\)\zs\*\ze[^\\\*\t ]" end="[^\\\*\t ]\zs\*\ze\_W" keepend
  46 syn region htmlItalic start="\%(^\|\s\)\zs_\ze[^\\_\t ]" end="[^\\_\t ]\zs_\ze\_W" keepend
  47 syn region htmlBold start="\*\*\ze\S" end="\S\zs\*\*" keepend
  48 syn region htmlBold start="__\ze\S" end="\S\zs__" keepend
  49 syn region htmlBoldItalic start="\*\*\*\ze\S" end="\S\zs\*\*\*" keepend
  50 syn region htmlBoldItalic start="___\ze\S" end="\S\zs___" keepend
  51
  52 " [link](URL) | [link][id] | [link][] | ![image](URL)
  53 syn region mkdFootnotes matchgroup=mkdDelimiter start="\[^"    end="\]"
  54 execute 'syn region mkdID matchgroup=mkdDelimiter    start="\["    end="\]" contained oneline' . s:conceal
  55 execute 'syn region mkdURL matchgroup=mkdDelimiter   start="("     end=")"  contained oneline' . s:conceal
  56 execute 'syn region mkdLink matchgroup=mkdDelimiter  start="\\\@<!!\?\[" end="\n\{-,1}[^]]\{-}\zs\]\ze[[(]" contains=@mkdNonListItem,@Spell nextgroup=mkdURL,mkdID skipwhite oneline' . s:concealends
  57
  58 " Autolink without angle brackets.
  59 " mkd  inline links:           protocol   optional  user:pass@       sub/domain                 .com, .co.uk, etc      optional port   path/querystring/hash fragment
  60 "                            ------------ _____________________ --------------------------- ________________________ ----------------- __
  61 syntax match   mkdInlineURL /https\?:\/\/\(\w\+\(:\w\+\)\?@\)\?\([A-Za-z][-_0-9A-Za-z]*\.\)\{1,}\(\w\{2,}\.\?\)\{1,}\(:[0-9]\{1,5}\)\?\S*/
  62
  63 " Autolink with parenthesis.
  64 syntax region  mkdInlineURL matchgroup=mkdDelimiter start="(\(https\?:\/\/\(\w\+\(:\w\+\)\?@\)\?\([A-Za-z][-_0-9A-Za-z]*\.\)\{1,}\(\w\{2,}\.\?\)\{1,}\(:[0-9]\{1,5}\)\?\S*)\)\@=" end=")"
  65
  66 " Autolink with angle brackets.
  67 syn region mkdInlineURL matchgroup=mkdDelimiter start="\\\@<!<\ze[a-z][a-z0-9,.-]\{1,22}:\/\/[^> ]*>" end=">"
  68
  69 " Link definitions: [id]: URL (Optional Title)
  70 syn region mkdLinkDef matchgroup=mkdDelimiter   start="^ \{,3}\zs\[" end="]:" oneline nextgroup=mkdLinkDefTarget skipwhite
  71 syn region mkdLinkDefTarget start="<\?\zs\S" excludenl end="\ze[>[:space:]\n]"   contained nextgroup=mkdLinkTitle,mkdLinkDef skipwhite skipnl oneline
  72 syn region mkdLinkTitle matchgroup=mkdDelimiter start=+"+     end=+"+  contained
  73 syn region mkdLinkTitle matchgroup=mkdDelimiter start=+'+     end=+'+  contained
  74 syn region mkdLinkTitle matchgroup=mkdDelimiter start=+(+     end=+)+  contained
  75
  76 "HTML headings
  77 syn region htmlH1       start="^\s*#"                   end="$" contains=@Spell
  78 syn region htmlH2       start="^\s*##"                  end="$" contains=@Spell
  79 syn region htmlH3       start="^\s*###"                 end="$" contains=@Spell
  80 syn region htmlH4       start="^\s*####"                end="$" contains=@Spell
  81 syn region htmlH5       start="^\s*#####"               end="$" contains=@Spell
  82 syn region htmlH6       start="^\s*######"              end="$" contains=@Spell
  83 syn match  htmlH1       /^.\+\n=\+$/ contains=@Spell
  84 syn match  htmlH2       /^.\+\n-\+$/ contains=@Spell
  85
  86 "define Markdown groups
  87 syn match  mkdLineBreak    /  \+$/
  88 syn region mkdBlockquote   start=/^\s*>/                   end=/$/ contains=mkdLineBreak,@Spell
  89 syn region mkdCode         start=/\(\([^\\]\|^\)\\\)\@<!`/ end=/\(\([^\\]\|^\)\\\)\@<!`/
  90 syn region mkdCode         start=/\s*``[^`]*/              end=/[^`]*``\s*/
  91 syn region mkdCode         start=/^\s*\z(`\{3,}\)\s*[0-9A-Za-z_+-]*\s*$/          end=/^\s*\z1`*\s*$/
  92 syn region mkdCode         start=/\s*\~\~[^\~]*/              end=/[^\~]*\~\~\s*/
  93 syn region mkdCode         start=/^\s*\z(\~\{3,}\)\s*[0-9A-Za-z_+-]*\s*$/         end=/^\s*\z1\~*\s*$/
  94 syn region mkdCode         start="<pre[^>]*\\\@<!>"        end="</pre>"
  95 syn region mkdCode         start="<code[^>]*\\\@<!>"       end="</code>"
  96 syn region mkdFootnote     start="\[^"                     end="\]"
  97 syn match  mkdCode         /^\s*\n\(\(\s\{8,}[^ ]\|\t\t\+[^\t]\).*\n\)\+/
  98 syn match  mkdCode         /\%^\(\(\s\{4,}[^ ]\|\t\+[^\t]\).*\n\)\+/
  99 syn match  mkdCode         /^\s*\n\(\(\s\{4,}[^ ]\|\t\+[^\t]\).*\n\)\+/ contained
 100 syn match  mkdListItem     /^\s*\%([-*+]\|\d\+\.\)\s\+/ contained
 101 syn region mkdListItemLine start="^\s*\%([-*+]\|\d\+\.\)\s\+" end="$" oneline contains=@mkdNonListItem,mkdListItem,@Spell
 102 syn region mkdNonListItemBlock start="\(\%^\(\s*\([-*+]\|\d\+\.\)\s\+\)\@!\|\n\(\_^\_$\|\s\{4,}[^ ]\|\t+[^\t]\)\@!\)" end="^\(\s*\([-*+]\|\d\+\.\)\s\+\)\@=" contains=@mkdNonListItem,@Spell
 103 syn match  mkdRule         /^\s*\*\s\{0,1}\*\s\{0,1}\*$/
 104 syn match  mkdRule         /^\s*-\s\{0,1}-\s\{0,1}-$/
 105 syn match  mkdRule         /^\s*_\s\{0,1}_\s\{0,1}_$/
 106 syn match  mkdRule         /^\s*-\{3,}$/
 107 syn match  mkdRule         /^\s*\*\{3,5}$/
 108
 109 " YAML frontmatter
 110 if get(g:, 'vim_markdown_frontmatter', 0)
 111   syn include @yamlTop syntax/yaml.vim
 112   syn region Comment matchgroup=mkdDelimiter start="\%^---$" end="^---$" contains=@yamlTop
 113   unlet! b:current_syntax
 114 endif
 115
 116 if get(g:, 'vim_markdown_toml_frontmatter', 0)
 117   try
 118     syn include @tomlTop syntax/toml.vim
 119     syn region Comment matchgroup=mkdDelimiter start="\%^+++$" end="^+++$" transparent contains=@tomlTop
 120     unlet! b:current_syntax
 121   catch /E484/
 122     syn region Comment matchgroup=mkdDelimiter start="\%^+++$" end="^+++$"
 123   endtry
 124 endif
 125
 126 if get(g:, 'vim_markdown_json_frontmatter', 0)
 127   try
 128     syn include @jsonTop syntax/json.vim
 129     syn region Comment matchgroup=mkdDelimiter start="\%^{$" end="^}$" contains=@jsonTop
 130     unlet! b:current_syntax
 131   catch /E484/
 132     syn region Comment matchgroup=mkdDelimiter start="\%^{$" end="^}$"
 133   endtry
 134 endif
 135
 136 if get(g:, 'vim_markdown_math', 0)
 137   syn include @tex syntax/tex.vim
 138   syn region mkdMath matchgroup=mkdDelimiter start="\\\@<!\$" end="\$" contains=@tex
 139   syn region mkdMath matchgroup=mkdDelimiter start="\\\@<!\$\$" end="\$\$" contains=@tex
 140 endif
 141
 142 syn cluster mkdNonListItem contains=@htmlTop,htmlItalic,htmlBold,htmlBoldItalic,mkdFootnotes,mkdInlineURL,mkdLink,mkdLinkDef,mkdLineBreak,mkdBlockquote,mkdCode,mkdRule,htmlH1,htmlH2,htmlH3,htmlH4,htmlH5,htmlH6,mkdMath
 143
 144 "highlighting for Markdown groups
 145 HtmlHiLink mkdString        String
 146 HtmlHiLink mkdCode          String
 147 HtmlHiLink mkdCodeStart     String
 148 HtmlHiLink mkdCodeEnd       String
 149 HtmlHiLink mkdFootnote      Comment
 150 HtmlHiLink mkdBlockquote    Comment
 151 HtmlHiLink mkdListItem      Identifier
 152 HtmlHiLink mkdRule          Identifier
 153 HtmlHiLink mkdLineBreak     Todo
 154 HtmlHiLink mkdFootnotes     htmlLink
 155 HtmlHiLink mkdLink          htmlLink
 156 HtmlHiLink mkdURL           htmlString
 157 HtmlHiLink mkdInlineURL     htmlLink
 158 HtmlHiLink mkdID            Identifier
 159 HtmlHiLink mkdLinkDef       mkdID
 160 HtmlHiLink mkdLinkDefTarget mkdURL
 161 HtmlHiLink mkdLinkTitle     htmlString
 162 HtmlHiLink mkdDelimiter     Delimiter
 163
 164 let b:current_syntax = "mkd"
 165
 166 delcommand HtmlHiLink
 167 " vim: ts=8