]> git.madduck.net Git - etc/vim.git/blob - syntax/mkd.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:

eb871651357200af9c89956e0fa59a0eac83c1fe
[etc/vim.git] / syntax / mkd.vim
1 " Vim syntax file
2 " Language:     Markdown
3 " Maintainer:   Ben Williams <benw@plasticboy.com>
4 " URL:          http://plasticboy.com/markdown-vim-mode/
5 " Version:      9
6 " Last Change:  2009 May 18 
7 " Remark:       Uses HTML syntax file
8 " Remark:       I don't do anything with angle brackets (<>) because that would too easily
9 "               easily conflict with HTML syntax
10 " TODO:         Handle stuff contained within stuff (e.g. headings within blockquotes)
11
12
13 " Read the HTML syntax to start with
14 if version < 600
15   so <sfile>:p:h/html.vim
16 else
17   runtime! syntax/html.vim
18
19   if exists('b:current_syntax')
20     unlet b:current_syntax
21   endif
22 endif
23
24 if version < 600
25   syntax clear
26 elseif exists("b:current_syntax")
27   finish
28 endif
29
30 " don't use standard HiLink, it will not work with included syntax files
31 if version < 508
32   command! -nargs=+ HtmlHiLink hi link <args>
33 else
34   command! -nargs=+ HtmlHiLink hi def link <args>
35 endif
36
37 syn spell toplevel
38 syn case ignore
39 syn sync linebreaks=1
40
41 "additions to HTML groups
42 syn region htmlItalic start="\\\@<!\*\S\@=" end="\S\@<=\\\@<!\*" keepend oneline
43 syn region htmlItalic start="\(^\|\s\)\@<=_\|\\\@<!_\([^_]\+\s\)\@=" end="\S\@<=_\|_\S\@=" keepend oneline
44 syn region htmlBold start="\S\@<=\*\*\|\*\*\S\@=" end="\S\@<=\*\*\|\*\*\S\@=" keepend oneline
45 syn region htmlBold start="\S\@<=__\|__\S\@=" end="\S\@<=__\|__\S\@=" keepend oneline
46 syn region htmlBoldItalic start="\S\@<=\*\*\*\|\*\*\*\S\@=" end="\S\@<=\*\*\*\|\*\*\*\S\@=" keepend oneline
47 syn region htmlBoldItalic start="\S\@<=___\|___\S\@=" end="\S\@<=___\|___\S\@=" keepend oneline
48
49 " [link](URL) | [link][id] | [link][]
50 syn region mkdFootnotes matchgroup=mkdDelimiter start="\[^"    end="\]"
51 syn region mkdID matchgroup=mkdDelimiter        start="\["    end="\]" contained oneline
52 syn region mkdURL matchgroup=mkdDelimiter       start="("     end=")"  contained oneline
53 syn region mkdLink matchgroup=mkdDelimiter      start="\\\@<!\[" end="\]\ze\s*[[(]" contains=@Spell nextgroup=mkdURL,mkdID skipwhite oneline
54 " mkd  inline links:           protocol   optional  user:pass@       sub/domain                 .com, .co.uk, etc      optional port   path/querystring/hash fragment
55 "                            ------------ _____________________ --------------------------- ________________________ ----------------- __
56 syntax match   mkdInlineURL /https\?:\/\/\(\w\+\(:\w\+\)\?@\)\?\([A-Za-z][-_0-9A-Za-z]*\.\)\{1,}\(\w\{2,}\.\?\)\{1,}\(:[0-9]\{1,5}\)\?\S*/
57
58 " Link definitions: [id]: URL (Optional Title)
59 " TODO handle automatic links without colliding with htmlTag (<URL>)
60 syn region mkdLinkDef matchgroup=mkdDelimiter   start="^ \{,3}\zs\[" end="]:" oneline nextgroup=mkdLinkDefTarget skipwhite
61 syn region mkdLinkDefTarget start="<\?\zs\S" excludenl end="\ze[>[:space:]\n]"   contained nextgroup=mkdLinkTitle,mkdLinkDef skipwhite skipnl oneline
62 syn region mkdLinkTitle matchgroup=mkdDelimiter start=+"+     end=+"+  contained
63 syn region mkdLinkTitle matchgroup=mkdDelimiter start=+'+     end=+'+  contained
64 syn region mkdLinkTitle matchgroup=mkdDelimiter start=+(+     end=+)+  contained
65
66 "define Markdown groups
67 syn match  mkdLineContinue ".$" contained
68 syn match  mkdLineBreak    /  \+$/
69 syn region mkdBlockquote   start=/^\s*>/                   end=/$/ contains=mkdLineBreak,mkdLineContinue,@Spell
70 syn region mkdCode         start=/\(\([^\\]\|^\)\\\)\@<!`/ end=/\(\([^\\]\|^\)\\\)\@<!`/
71 syn region mkdCode         start=/\s*``[^`]*/              end=/[^`]*``\s*/
72 syn region mkdCode         start=/^\s*```\s*[0-9A-Za-z_-]*\s*$/          end=/^\s*```\s*$/
73 syn region mkdCode         start="<pre[^>]*>"              end="</pre>"
74 syn region mkdCode         start="<code[^>]*>"             end="</code>"
75 syn region mkdFootnote     start="\[^"                     end="\]"
76 syn match  mkdCode         /^\s*\n\(\(\s\{8,}[^ ]\|\t\t\+[^\t]\).*\n\)\+/
77 syn match  mkdIndentCode   /^\s*\n\(\(\s\{4,}[^ ]\|\t\+[^\t]\).*\n\)\+/ contained
78 syn match  mkdListItem     "^\s*[-*+]\s\+"
79 syn match  mkdListItem     "^\s*\d\+\.\s\+"
80 syn region mkdNonListItemBlock start="\n\(\_^\_$\|\s\{4,}[^ ]\|\t+[^\t]\)\@!" end="^\(\s*\([-*+]\|\d\+\.\)\s\+\)\@=" contains=@mkdNonListItem,@Spell
81 syn match  mkdRule         /^\s*\*\s\{0,1}\*\s\{0,1}\*$/
82 syn match  mkdRule         /^\s*-\s\{0,1}-\s\{0,1}-$/
83 syn match  mkdRule         /^\s*_\s\{0,1}_\s\{0,1}_$/
84 syn match  mkdRule         /^\s*-\{3,}$/
85 syn match  mkdRule         /^\s*\*\{3,5}$/
86
87 "HTML headings
88 syn region htmlH1       start="^\s*#"                   end="\($\|#\+\)" contains=@Spell
89 syn region htmlH2       start="^\s*##"                  end="\($\|#\+\)" contains=@Spell
90 syn region htmlH3       start="^\s*###"                 end="\($\|#\+\)" contains=@Spell
91 syn region htmlH4       start="^\s*####"                end="\($\|#\+\)" contains=@Spell
92 syn region htmlH5       start="^\s*#####"               end="\($\|#\+\)" contains=@Spell
93 syn region htmlH6       start="^\s*######"              end="\($\|#\+\)" contains=@Spell
94 syn match  htmlH1       /^.\+\n=\+$/ contains=@Spell
95 syn match  htmlH2       /^.\+\n-\+$/ contains=@Spell
96
97 if get(g:, 'vim_markdown_math', 0)
98   syn region mkdMath matchgroup=mkdDelimiter start="\\\@<!\$" end="\$"
99   syn region mkdMath matchgroup=mkdDelimiter start="\\\@<!\$\$" end="\$\$"
100 endif
101
102 syn cluster mkdNonListItem contains=htmlItalic,htmlBold,htmlBoldItalic,mkdFootnotes,mkdID,mkdURL,mkdLink,mkdLinkDef,mkdLineBreak,mkdBlockquote,mkdCode,mkdMath,mkdIndentCode,mkdListItem,mkdRule,htmlH1,htmlH2,htmlH3,htmlH4,htmlH5,htmlH6
103
104 " YAML frontmatter
105 if get(g:, 'vim_markdown_frontmatter', 0)
106   syn include @yamlTop syntax/yaml.vim
107   syn region Comment matchgroup=mkdDelimiter start="\%^---$" end="^---$" contains=@yamlTop
108 endif
109
110 "highlighting for Markdown groups
111 HtmlHiLink mkdString        String
112 HtmlHiLink mkdCode          String
113 HtmlHiLink mkdIndentCode    String
114 HtmlHiLink mkdFootnote    Comment
115 HtmlHiLink mkdBlockquote    Comment
116 HtmlHiLink mkdLineContinue  Comment
117 HtmlHiLink mkdListItem      Identifier
118 HtmlHiLink mkdRule          Identifier
119 HtmlHiLink mkdLineBreak     Todo
120 HtmlHiLink mkdFootnotes     htmlLink
121 HtmlHiLink mkdLink          htmlLink
122 HtmlHiLink mkdURL           htmlString
123 HtmlHiLink mkdInlineURL     htmlLink
124 HtmlHiLink mkdID            Identifier
125 HtmlHiLink mkdLinkDef       mkdID
126 HtmlHiLink mkdLinkDefTarget mkdURL
127 HtmlHiLink mkdLinkTitle     htmlString
128 HtmlHiLink mkdMath          Statement
129 HtmlHiLink mkdDelimiter     Delimiter
130
131 " Automatically insert bullets
132 setlocal formatoptions+=r
133 " Do not automatically insert bullets when auto-wrapping with text-width
134 setlocal formatoptions-=c
135 " Accept various markers as bullets
136 setlocal comments=b:*,b:+,b:-
137
138 " Automatically continue blockquote on line break
139 setlocal comments+=b:>
140
141 let b:current_syntax = "mkd"
142
143 delcommand HtmlHiLink
144 " vim: ts=8