]> 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:

c4ceec415a2e21e7b88d5f5b2cc12a47d8149180
[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   unlet b:current_syntax
19 endif
20
21 if version < 600
22   syntax clear
23 elseif exists("b:current_syntax")
24   finish
25 endif
26
27 " don't use standard HiLink, it will not work with included syntax files
28 if version < 508
29   command! -nargs=+ HtmlHiLink hi link <args>
30 else
31   command! -nargs=+ HtmlHiLink hi def link <args>
32 endif
33
34 syn spell toplevel
35 syn case ignore
36 syn sync linebreaks=1
37
38 "additions to HTML groups
39 syn region htmlItalic start="\\\@<!\*\S\@=" end="\S\@<=\\\@<!\*" keepend oneline
40 syn region htmlItalic start="\(^\|\s\)\@<=_\|\\\@<!_\([^_]\+\s\)\@=" end="\S\@<=_\|_\S\@=" keepend oneline
41 syn region htmlBold start="\S\@<=\*\*\|\*\*\S\@=" end="\S\@<=\*\*\|\*\*\S\@=" keepend oneline
42 syn region htmlBold start="\S\@<=__\|__\S\@=" end="\S\@<=__\|__\S\@=" keepend oneline
43 syn region htmlBoldItalic start="\S\@<=\*\*\*\|\*\*\*\S\@=" end="\S\@<=\*\*\*\|\*\*\*\S\@=" keepend oneline
44 syn region htmlBoldItalic start="\S\@<=___\|___\S\@=" end="\S\@<=___\|___\S\@=" keepend oneline
45
46 " [link](URL) | [link][id] | [link][]
47 syn region mkdFootnotes matchgroup=mkdDelimiter start="\[^"    end="\]"
48 syn region mkdID matchgroup=mkdDelimiter        start="\["    end="\]" contained oneline
49 syn region mkdURL matchgroup=mkdDelimiter       start="("     end=")"  contained oneline
50 syn region mkdLink matchgroup=mkdDelimiter      start="\\\@<!\[" end="\]\ze\s*[[(]" contains=@Spell nextgroup=mkdURL,mkdID skipwhite oneline
51 " mkd  inline links:           protocol   optional  user:pass@       sub/domain                 .com, .co.uk, etc      optional port   path/querystring/hash fragment
52 "                            ------------ _____________________ --------------------------- ________________________ ----------------- __
53 syntax match   mkdInlineURL /https\?:\/\/\(\w\+\(:\w\+\)\?@\)\?\([A-Za-z][-_0-9A-Za-z]*\.\)\{1,}\(\w\{2,}\.\?\)\{1,}\(:[0-9]\{1,5}\)\?\S*/
54
55 " Link definitions: [id]: URL (Optional Title)
56 " TODO handle automatic links without colliding with htmlTag (<URL>)
57 syn region mkdLinkDef matchgroup=mkdDelimiter   start="^ \{,3}\zs\[" end="]:" oneline nextgroup=mkdLinkDefTarget skipwhite
58 syn region mkdLinkDefTarget start="<\?\zs\S" excludenl end="\ze[>[:space:]\n]"   contained nextgroup=mkdLinkTitle,mkdLinkDef skipwhite skipnl oneline
59 syn region mkdLinkTitle matchgroup=mkdDelimiter start=+"+     end=+"+  contained
60 syn region mkdLinkTitle matchgroup=mkdDelimiter start=+'+     end=+'+  contained
61 syn region mkdLinkTitle matchgroup=mkdDelimiter start=+(+     end=+)+  contained
62
63 "define Markdown groups
64 syn match  mkdLineContinue ".$" contained
65 syn match  mkdLineBreak    /  \+$/
66 syn region mkdBlockquote   start=/^\s*>/                   end=/$/ contains=mkdLineBreak,mkdLineContinue,@Spell
67 syn region mkdCode         start=/\(\([^\\]\|^\)\\\)\@<!`/ end=/\(\([^\\]\|^\)\\\)\@<!`/
68 syn region mkdCode         start=/\s*``[^`]*/              end=/[^`]*``\s*/
69 syn region mkdCode         start=/^```\s*[0-9A-Za-z_-]*\s*$/          end=/^```\s*$/
70 syn region mkdCode         start="<pre[^>]*>"              end="</pre>"
71 syn region mkdCode         start="<code[^>]*>"             end="</code>"
72 syn region mkdFootnote     start="\[^"                     end="\]"
73 syn match  mkdCode         /^\s*\n\(\(\s\{8,}[^ ]\|\t\t\+[^\t]\).*\n\)\+/
74 syn match  mkdIndentCode   /^\s*\n\(\(\s\{4,}[^ ]\|\t\+[^\t]\).*\n\)\+/ contained
75 syn match  mkdListItem     "^\s*[-*+]\s\+"
76 syn match  mkdListItem     "^\s*\d\+\.\s\+"
77 syn region mkdNonListItemBlock start="\n\(\_^\_$\|\s\{4,}[^ ]\|\t+[^\t]\)\@!" end="^\(\s*\([-*+]\|\d\+\.\)\s\+\)\@=" contains=@mkdNonListItem
78 syn match  mkdRule         /^\s*\*\s\{0,1}\*\s\{0,1}\*$/
79 syn match  mkdRule         /^\s*-\s\{0,1}-\s\{0,1}-$/
80 syn match  mkdRule         /^\s*_\s\{0,1}_\s\{0,1}_$/
81 syn match  mkdRule         /^\s*-\{3,}$/
82 syn match  mkdRule         /^\s*\*\{3,5}$/
83
84 "HTML headings
85 syn region htmlH1       start="^\s*#"                   end="\($\|#\+\)" contains=@Spell
86 syn region htmlH2       start="^\s*##"                  end="\($\|#\+\)" contains=@Spell
87 syn region htmlH3       start="^\s*###"                 end="\($\|#\+\)" contains=@Spell
88 syn region htmlH4       start="^\s*####"                end="\($\|#\+\)" contains=@Spell
89 syn region htmlH5       start="^\s*#####"               end="\($\|#\+\)" contains=@Spell
90 syn region htmlH6       start="^\s*######"              end="\($\|#\+\)" contains=@Spell
91 syn match  htmlH1       /^.\+\n=\+$/ contains=@Spell
92 syn match  htmlH2       /^.\+\n-\+$/ contains=@Spell
93
94 syn cluster mkdNonListItem contains=htmlItalic,htmlBold,htmlBoldItalic,mkdFootnotes,mkdID,mkdURL,mkdLink,mkdLinkDef,mkdLineBreak,mkdBlockquote,mkdCode,mkdIndentCode,mkdListItem,mkdRule,htmlH1,htmlH2,htmlH3,htmlH4,htmlH5,htmlH6
95
96 "highlighting for Markdown groups
97 HtmlHiLink mkdString        String
98 HtmlHiLink mkdCode          String
99 HtmlHiLink mkdIndentCode    String
100 HtmlHiLink mkdFootnote    Comment
101 HtmlHiLink mkdBlockquote    Comment
102 HtmlHiLink mkdLineContinue  Comment
103 HtmlHiLink mkdListItem      Identifier
104 HtmlHiLink mkdRule          Identifier
105 HtmlHiLink mkdLineBreak     Todo
106 HtmlHiLink mkdFootnotes     htmlLink
107 HtmlHiLink mkdLink          htmlLink
108 HtmlHiLink mkdURL           htmlString
109 HtmlHiLink mkdInlineURL     htmlLink
110 HtmlHiLink mkdID            Identifier
111 HtmlHiLink mkdLinkDef       mkdID
112 HtmlHiLink mkdLinkDefTarget mkdURL
113 HtmlHiLink mkdLinkTitle     htmlString
114
115 HtmlHiLink mkdDelimiter     Delimiter
116
117 " Automatically insert bullets
118 setlocal formatoptions+=r
119 " Accept various markers as bullets
120 setlocal comments=b:*,b:+,b:-
121
122 let b:current_syntax = "mkd"
123
124 delcommand HtmlHiLink
125 " vim: ts=8