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

8f3fd86ad30a7c152083b1f6c6f8ff0cf94bd4fd
[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 htmlBold     start=/\\\@<!\(^\|\A\)\@=\*\@<!\*\*\*\@!/     end=/\\\@<!\*\@<!\*\*\*\@!\($\|\A\)\@=/   contains=@Spell,htmlItalic
40 syn region htmlItalic   start=/\\\@<!\(^\|\A\)\@=\*\@<!\*\*\@!/       end=/\\\@<!\*\@<!\*\*\@!\($\|\A\)\@=/      contains=htmlBold,@Spell
41 syn region htmlBold     start=/\\\@<!\(^\|\A\)\@=_\@<!___\@!/         end=/\\\@<!_\@<!___\@!\($\|\A\)\@=/       contains=htmlItalic,@Spell
42 syn region htmlItalic   start=/\\\@<!\(^\|\A\)\@=_\@<!__\@!/          end=/\\\@<!_\@<!__\@!\($\|\A\)\@=/        contains=htmlBold,@Spell
43
44 " [link](URL) | [link][id] | [link][]
45 syn region mkdFootnotes matchgroup=mkdDelimiter start="\[^"    end="\]"
46 syn region mkdLink matchgroup=mkdDelimiter      start="[^\\]\!\?\[" end="\]\ze\s*[[(]" contains=@Spell nextgroup=mkdURL,mkdID skipwhite
47 syn region mkdID matchgroup=mkdDelimiter        start="\["    end="\]" contained
48 syn region mkdURL matchgroup=mkdDelimiter       start="("     end=")"  contained
49 " mkd  inline links:           protocol   optional  user:pass@       sub/domain                 .com, .co.uk, etc      optional port   path/querystring/hash fragment
50 "                            ------------ _____________________ --------------------------- ________________________ ----------------- __
51 syntax match   mkdInlineURL /https\?:\/\/\(\w\+\(:\w\+\)\?@\)\?\([A-Za-z][-_0-9A-Za-z]*\.\)\{1,}\(\w\{2,}\.\?\)\{1,}\(:[0-9]\{1,5}\)\?\S*/
52
53 " Link definitions: [id]: URL (Optional Title)
54 " TODO handle automatic links without colliding with htmlTag (<URL>)
55 syn region mkdLinkDef matchgroup=mkdDelimiter   start="^ \{,3}\zs\[" end="]:" oneline nextgroup=mkdLinkDefTarget skipwhite
56 syn region mkdLinkDefTarget start="<\?\zs\S" excludenl end="\ze[>[:space:]\n]"   contained nextgroup=mkdLinkTitle,mkdLinkDef skipwhite skipnl oneline
57 syn region mkdLinkTitle matchgroup=mkdDelimiter start=+"+     end=+"+  contained
58 syn region mkdLinkTitle matchgroup=mkdDelimiter start=+'+     end=+'+  contained
59 syn region mkdLinkTitle matchgroup=mkdDelimiter start=+(+     end=+)+  contained
60
61 "define Markdown groups
62 syn match  mkdLineContinue ".$" contained
63 syn match  mkdRule      /^\s*\*\s\{0,1}\*\s\{0,1}\*$/
64 syn match  mkdRule      /^\s*-\s\{0,1}-\s\{0,1}-$/
65 syn match  mkdRule      /^\s+_\s\{0,1}_\s\{0,1}_$/
66 syn match  mkdRule      /^\s*-\{3,}$/
67 syn match  mkdRule      /^\s*\*\{3,5}$/
68 syn match  mkdListItem  "^\s*[-*+]\s\+"
69 syn match  mkdListItem  "^\s*\d\+\.\s\+"
70 syn match  mkdCode      /^\s*\n\(\(\s\{4,}[^ ]\|\t\+[^\t]\).*\n\)\+/
71 syn match  mkdLineBreak /  \+$/
72 syn region mkdCode      start=/\\\@<!`/                   end=/\\\@<!`/
73 syn region mkdCode      start=/\s*``[^`]*/          end=/[^`]*``\s*/
74 syn region mkdCode      start=/^```\s*\w*\s*$/          end=/^```\s*$/
75 syn region mkdBlockquote start=/^\s*>/              end=/$/                 contains=mkdLineBreak,mkdLineContinue,@Spell
76 syn region mkdCode      start="<pre[^>]*>"         end="</pre>"
77 syn region mkdCode      start="<code[^>]*>"        end="</code>"
78
79 "HTML headings
80 syn region htmlH1       start="^\s*#"                   end="\($\|#\+\)" contains=@Spell
81 syn region htmlH2       start="^\s*##"                  end="\($\|#\+\)" contains=@Spell
82 syn region htmlH3       start="^\s*###"                 end="\($\|#\+\)" contains=@Spell
83 syn region htmlH4       start="^\s*####"                end="\($\|#\+\)" contains=@Spell
84 syn region htmlH5       start="^\s*#####"               end="\($\|#\+\)" contains=@Spell
85 syn region htmlH6       start="^\s*######"              end="\($\|#\+\)" contains=@Spell
86 syn match  htmlH1       /^.\+\n=\+$/ contains=@Spell
87 syn match  htmlH2       /^.\+\n-\+$/ contains=@Spell
88
89
90
91 " fold region for headings
92 syn region mkdHeaderFold
93     \ start="^\s*\z(#\+\)"
94     \ skip="^\s*\z1#\+"
95     \ end="^\(\s*#\)\@="
96     \ fold contains=TOP
97
98 " fold region for lists
99 syn region mkdListFold
100     \ start="^\z(\s*\)\*\z(\s*\)"
101     \ skip="^\z1 \z2\s*[^#]"
102     \ end="^\(.\)\@="
103     \ fold contains=TOP
104
105 syn sync fromstart
106 setlocal foldmethod=syntax
107
108
109
110 "highlighting for Markdown groups
111 HtmlHiLink mkdString        String
112 HtmlHiLink mkdCode          String
113 HtmlHiLink mkdBlockquote    Comment
114 HtmlHiLink mkdLineContinue  Comment
115 HtmlHiLink mkdListItem      Identifier
116 HtmlHiLink mkdRule          Identifier
117 HtmlHiLink mkdLineBreak     Todo
118 HtmlHiLink mkdFootnotes     htmlLink
119 HtmlHiLink mkdLink          htmlLink
120 HtmlHiLink mkdURL           htmlString
121 HtmlHiLink mkdInlineURL     htmlLink
122 HtmlHiLink mkdID            Identifier
123 HtmlHiLink mkdLinkDef       mkdID
124 HtmlHiLink mkdLinkDefTarget mkdURL
125 HtmlHiLink mkdLinkTitle     htmlString
126
127 HtmlHiLink mkdDelimiter     Delimiter
128
129 let b:current_syntax = "mkd"
130
131 delcommand HtmlHiLink
132 " vim: ts=8