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.
1 *vim-markdown* Vim Markdown
3 ===============================================================================
6 1. Introduction |vim-markdown-introduction|
7 2. Installation |vim-markdown-installation|
8 3. Options |vim-markdown-options|
9 1. Disable Folding |vim-markdown-disable-folding|
10 2. Change fold style |vim-markdown-change-fold-style|
11 3. Set header folding level |vim-markdown-set-header-folding-level|
12 4. Disable Default Key Mappings |vim-markdown-disable-default-key-mappings|
13 5. Enable TOC window auto-fit |vim-markdown-enable-toc-window-auto-fit|
14 6. Text emphasis restriction to single-lines
15 |vim-markdown-text-emphasis-restriction-to-single-lines|
16 7. Syntax Concealing |vim-markdown-syntax-concealing|
17 8. Fenced code block languages |vim-markdown-fenced-code-block-languages|
18 9. Syntax extensions |vim-markdown-syntax-extensions|
19 1. LaTeX math |vim-markdown-latex-math|
20 2. YAML Front Matter |vim-markdown-yaml-front-matter|
21 3. TOML Front Matter |vim-markdown-toml-front-matter|
22 4. JSON Front Matter |vim-markdown-json-front-matter|
23 10. Adjust new list item indent |vim-markdown-adjust-new-list-item-indent|
24 4. Mappings |vim-markdown-mappings|
25 5. Commands |vim-markdown-commands|
26 6. Credits |vim-markdown-credits|
27 7. License |vim-markdown-license|
28 8. References |vim-markdown-references|
30 ===============================================================================
31 *vim-markdown-introduction*
34 Syntax highlighting, matching rules and mappings for the original Markdown [1]
37 ===============================================================================
38 *vim-markdown-installation*
41 If you use Vundle [2], add the following line to your '~/.vimrc':
43 Plugin 'godlygeek/tabular'
44 Plugin 'plasticboy/vim-markdown'
46 The 'tabular' plugin must come _before_ 'vim-markdown'.
53 If you use Pathogen [3], do this:
56 git clone https://github.com/plasticboy/vim-markdown.git
58 To install without Pathogen using the Debian vim-addon-manager [4], do this:
60 git clone https://github.com/plasticboy/vim-markdown.git
63 vim-addon-manager install markdown
65 If you are not using any package manager, download the tarball [5] and do this:
68 tar --strip=1 -zxf vim-markdown-master.tar.gz
70 ===============================================================================
71 *vim-markdown-options*
74 -------------------------------------------------------------------------------
75 *vim-markdown-disable-folding*
78 Add the following line to your '.vimrc' to disable the folding configuration:
80 let g:vim_markdown_folding_disabled = 1
82 This option only controls Vim Markdown specific folding configuration.
84 To enable/disable folding use Vim's standard folding configuration.
88 -------------------------------------------------------------------------------
89 *vim-markdown-change-fold-style*
92 To fold in a style like python-mode [6], add the following to your '.vimrc':
94 let g:vim_markdown_folding_style_pythonic = 1
96 Level 1 heading which is served as a document title is not folded.
97 'g:vim_markdown_folding_level' setting is not active with this fold style.
99 To prevent foldtext from being overridden, add the following to your '.vimrc':
101 let g:vim_markdown_override_foldtext = 0
103 -------------------------------------------------------------------------------
104 *vim-markdown-set-header-folding-level*
105 Set header folding level ~
107 Folding level is a number between 1 and 6. By default, if not specified, it is
110 let g:vim_markdown_folding_level = 6
112 Tip: it can be changed on the fly with:
114 :let g:vim_markdown_folding_level = 1
117 -------------------------------------------------------------------------------
118 *vim-markdown-disable-default-key-mappings*
119 Disable Default Key Mappings ~
121 Add the following line to your '.vimrc' to disable default key mappings:
123 let g:vim_markdown_no_default_key_mappings = 1
125 You can also map them by yourself with '<Plug>' mappings.
127 -------------------------------------------------------------------------------
128 *vim-markdown-enable-toc-window-auto-fit*
129 Enable TOC window auto-fit ~
131 Allow for the TOC window to auto-fit when it's possible for it to shrink. It
132 never increases its default size (half screen), it only shrinks.
134 let g:vim_markdown_toc_autofit = 1
136 -------------------------------------------------------------------------------
137 *vim-markdown-text-emphasis-restriction-to-single-lines*
138 Text emphasis restriction to single-lines ~
140 By default text emphasis works across multiple lines until a closing token is
141 found. However, it's possible to restrict text emphasis to a single line (ie,
142 for it to be applied a closing token must be found on the same line). To do so:
144 let g:vim_markdown_emphasis_multiline = 0
146 -------------------------------------------------------------------------------
147 *vim-markdown-syntax-concealing*
150 Concealing is set for some syntax.
152 For example, conceal '[link text](link url)' as just 'link text'.
154 To enable conceal use Vim's standard conceal configuration.
158 To disable conceal regardless of 'conceallevel' setting, add the following to
161 let g:vim_markdown_conceal = 0
163 -------------------------------------------------------------------------------
164 *vim-markdown-fenced-code-block-languages*
165 Fenced code block languages ~
167 You can use filetype name as fenced code block languages for syntax
168 highlighting. If you want to use different name from filetype, you can add it
169 in your '.vimrc' like so:
171 let g:vim_markdown_fenced_languages = ['csharp=cs']
173 This will cause the following to be highlighted using the 'cs' filetype syntax.
179 Default is "['c++=cpp', 'viml=vim', 'bash=sh', 'ini=dosini']".
181 -------------------------------------------------------------------------------
182 *vim-markdown-syntax-extensions*
185 The following options control which syntax extensions will be turned on. They
188 -------------------------------------------------------------------------------
189 *vim-markdown-latex-math*
192 Used as '$x^2$', '$$x^2$$', escapable as '\$x\$' and '\$\$x\$\$'.
194 let g:vim_markdown_math = 1
196 -------------------------------------------------------------------------------
197 *vim-markdown-yaml-front-matter*
200 Highlight YAML front matter as used by Jekyll or Hugo [7].
202 let g:vim_markdown_frontmatter = 1
204 -------------------------------------------------------------------------------
205 *vim-markdown-toml-front-matter*
208 Highlight TOML front matter as used by Hugo [7].
210 TOML syntax highlight requires vim-toml [8].
212 let g:vim_markdown_toml_frontmatter = 1
214 -------------------------------------------------------------------------------
215 *vim-markdown-json-front-matter*
218 Highlight JSON front matter as used by Hugo [7].
220 JSON syntax highlight requires vim-json [9].
222 let g:vim_markdown_json_frontmatter = 1
224 -------------------------------------------------------------------------------
225 *vim-markdown-adjust-new-list-item-indent*
226 Adjust new list item indent ~
228 You can adjust a new list indent. For example, you insert a single line like
233 Then if you type 'o' to insert new line in vim and type '* item2', the result
239 vim-markdown automatically insert the indent. By default, the number of spaces
240 of indent is 4. If you'd like to change the number as 2, just write:
242 let g:vim_markdown_new_list_item_indent = 2
244 ===============================================================================
245 *vim-markdown-mappings*
248 The following work on normal and visual modes:
251 - 'gx': open the link under the cursor in the same browser as the standard
252 'gx' command. '<Plug>Markdown_OpenUrlUnderCursor'
254 The standard 'gx' is extended by allowing you to put your cursor anywhere
257 For example, all the following cursor positions will work:
259 [Example](http://example.com)
267 Known limitation: does not work for links that span multiple lines.
270 - 'ge': open the link under the cursor in Vim for editing. Useful for
271 relative markdown links. '<Plug>Markdown_EditUrlUnderCursor'
273 The rules for the cursor position are the same as the 'gx' command.
276 - ']]': go to next header. '<Plug>Markdown_MoveToNextHeader'
279 - '[[': go to previous header. Contrast with ']c'.
280 '<Plug>Markdown_MoveToPreviousHeader'
283 - '][': go to next sibling header if any.
284 '<Plug>Markdown_MoveToNextSiblingHeader'
287 - '[]': go to previous sibling header if any.
288 '<Plug>Markdown_MoveToPreviousSiblingHeader'
291 - ']c': go to Current header. '<Plug>Markdown_MoveToCurHeader'
294 - ']u': go to parent header (Up). '<Plug>Markdown_MoveToParentHeader'
296 This plugin follows the recommended Vim plugin mapping interface, so to change
297 the map ']u' to 'asdf', add to your '.vimrc':
299 map asdf <Plug>Markdown_MoveToParentHeader
301 To disable a map use:
303 map <Plug> <Plug>Markdown_MoveToParentHeader
305 ===============================================================================
306 *vim-markdown-commands*
309 The following requires ':filetype plugin on'.
314 Decrease level of all headers in buffer: 'h2' to 'h1', 'h3' to 'h2', etc.
316 If range is given, only operate in the range.
318 If an 'h1' would be decreased, abort.
320 For simplicity of implementation, Setex headers are converted to Atx.
323 - ':HeaderIncrease': Analogous to ':HeaderDecrease', but increase levels
329 Convert all Setex style headers in buffer to Atx.
331 If a range is given, e.g. hit ':' from visual mode, only operate on the
335 - ':TableFormat': Format the table under the cursor like this [10].
337 Requires Tabular [11].
339 The input table _must_ already have a separator line as the second line of
340 the table. That line only needs to contain the correct pipes '|', nothing
344 - ':Toc': create a quickfix vertical window navigable table of contents with
347 Hit '<Enter>' on a line to jump to the corresponding line of the markdown
351 - ':Toch': Same as ':Toc' but in an horizontal window.
354 - ':Toct': Same as ':Toc' but in a new tab.
357 - ':Tocv': Same as ':Toc' for symmetry with ':Toch' and ':Tocv'.
359 ===============================================================================
360 *vim-markdown-credits*
363 The main contributors of vim-markdown are:
365 - **Ben Williams** (A.K.A. **plasticboy**). The original developer of vim-
366 markdown. Homepage [12].
368 If you feel that your name should be on this list, please make a pull request
369 listing your contributions.
371 ===============================================================================
372 *vim-markdown-license*
375 The MIT License (MIT)
377 Copyright (c) 2012 Benjamin D. Williams
379 Permission is hereby granted, free of charge, to any person obtaining a copy of
380 this software and associated documentation files (the "Software"), to deal in
381 the Software without restriction, including without limitation the rights to
382 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
383 of the Software, and to permit persons to whom the Software is furnished to do
384 so, subject to the following conditions:
386 The above copyright notice and this permission notice shall be included in all
387 copies or substantial portions of the Software.
389 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
390 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
391 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
392 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
393 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
394 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
397 ===============================================================================
398 *vim-markdown-references*
401 [1] http://daringfireball.net/projects/markdown/
402 [2] https://github.com/gmarik/vundle
403 [3] https://github.com/tpope/vim-pathogen
404 [4] http://packages.qa.debian.org/v/vim-addon-manager.html
405 [5] https://github.com/plasticboy/vim-markdown/archive/master.tar.gz
406 [6] https://github.com/klen/python-mode
407 [7] https://gohugo.io/content/front-matter/
408 [8] https://github.com/cespare/vim-toml
409 [9] https://github.com/elzr/vim-json
410 [10] http://www.cirosantilli.com/markdown-style-guide/#tables
411 [11] https://github.com/godlygeek/tabular
412 [12] http://plasticboy.com/