]> git.madduck.net Git - etc/vim.git/blob - README.md

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:

b67917a7804edd75ea145ab8bdc4f6352c263ade
[etc/vim.git] / README.md
1 # Vim Markdown
2
3 [![Build Status](https://travis-ci.org/plasticboy/vim-markdown.svg)](https://travis-ci.org/plasticboy/vim-markdown)
4
5 Syntax highlighting, matching rules and mappings for [the original Markdown](http://daringfireball.net/projects/markdown/) and extensions.
6
7 1. [Installation](#installation)
8 1. [Basic usage](#basic-usage)
9 1. [Options](#options)
10 1. [Mappings](#mappings)
11 1. [Commands](#commands)
12 1. [Credits](#credits)
13 1. [License](#license)
14
15 ## Installation
16
17 If you use [Vundle](https://github.com/gmarik/vundle), add the following lines to your `~/.vimrc`:
18
19 ```vim
20 Plugin 'godlygeek/tabular'
21 Plugin 'plasticboy/vim-markdown'
22 ```
23
24 The `tabular` plugin must come *before* `vim-markdown`.
25
26 Then run inside Vim:
27
28 ```vim
29 :so ~/.vimrc
30 :PluginInstall
31 ```
32
33 If you use [Pathogen](https://github.com/tpope/vim-pathogen), do this:
34
35 ```sh
36 cd ~/.vim/bundle
37 git clone https://github.com/plasticboy/vim-markdown.git
38 ```
39
40 To install without Pathogen using the Debian [vim-addon-manager](http://packages.qa.debian.org/v/vim-addon-manager.html), do this:
41
42 ```sh
43 git clone https://github.com/plasticboy/vim-markdown.git
44 cd vim-markdown
45 sudo make install
46 vim-addon-manager install markdown
47 ```
48
49 If you are not using any package manager, download the [tarball](https://github.com/plasticboy/vim-markdown/archive/master.tar.gz) and do this:
50
51 ```sh
52 cd ~/.vim
53 tar --strip=1 -zxf vim-markdown-master.tar.gz
54 ```
55
56 ## Basic usage
57
58 ### Folding
59
60 Folding is enabled for headers by default.
61
62 The following commands are useful to open and close folds:
63
64 - `zr`: reduces fold level throughout the buffer
65 - `zR`: opens all folds
66 - `zm`: increases fold level throughout the buffer
67 - `zM`: folds everything all the way
68 - `za`: open a fold your cursor is on
69 - `zA`: open a fold your cursor is on recursively
70 - `zc`: close a fold your cursor is on
71 - `zC`: close a fold your cursor is on recursively
72
73 [Options](#options) are available to disable folding or change folding style.
74
75 Try `:help fold-expr` and `:help fold-commands` for details.
76
77 ### Concealing
78
79 Concealing is set for some syntax such as bold, italic, code block and link.
80
81 Concealing lets you conceal text with other text. The actual source text is not modified. If you put your cursor on the concealed line, the conceal goes away.
82
83 [Options](#options) are available to disable or change concealing.
84
85 Try `:help concealcursor` and `:help conceallevel` for details.
86
87 ## Options
88
89 ### Disable Folding
90
91 Add the following line to your `.vimrc` to disable the folding configuration:
92
93 ```vim
94 let g:vim_markdown_folding_disabled = 1
95 ```
96
97 This option only controls Vim Markdown specific folding configuration.
98
99 To enable/disable folding use Vim's standard folding configuration.
100
101 ```vim
102 set [no]foldenable
103 ```
104
105 ### Change fold style
106
107 To fold in a style like [python-mode](https://github.com/klen/python-mode), add the following to your `.vimrc`:
108
109 ```vim
110 let g:vim_markdown_folding_style_pythonic = 1
111 ```
112
113 Level 1 heading which is served as a document title is not folded.
114 `g:vim_markdown_folding_level` setting is not active with this fold style.
115
116 To prevent foldtext from being set add the following to your `.vimrc`:
117
118 ```vim
119 let g:vim_markdown_override_foldtext = 0
120 ```
121
122 ### Set header folding level
123
124 Folding level is a number between 1 and 6. By default, if not specified, it is set to 1.
125
126 ```vim
127 let g:vim_markdown_folding_level = 6
128 ```
129
130 Tip: it can be changed on the fly with:
131
132 ```vim
133 :let g:vim_markdown_folding_level = 1
134 :edit
135 ```
136
137 ### Disable Default Key Mappings
138
139 Add the following line to your `.vimrc` to disable default key mappings:
140
141 ```vim
142 let g:vim_markdown_no_default_key_mappings = 1
143 ```
144
145 You can also map them by yourself with `<Plug>` mappings.
146
147 ### Enable TOC window auto-fit
148
149 Allow for the TOC window to auto-fit when it's possible for it to shrink.
150 It never increases its default size (half screen), it only shrinks.
151
152 ```vim
153 let g:vim_markdown_toc_autofit = 1
154 ```
155
156 ### Text emphasis restriction to single-lines
157
158 By default text emphasis works across multiple lines until a closing token is found. However, it's possible to restrict text emphasis to a single line (i.e., for it to be applied a closing token must be found on the same line). To do so:
159
160 ```vim
161 let g:vim_markdown_emphasis_multiline = 0
162 ```
163
164 ### Syntax Concealing
165
166 Concealing is set for some syntax.
167
168 For example, conceal `[link text](link url)` as just `link text`.
169 Also, `_italic_` and `*italic*` will conceal to just _italic_.
170 Similarly `__bold__`, `**bold**`, `___italic bold___`, and `***italic bold***`
171 will conceal to just __bold__, **bold**, ___italic bold___, and ***italic bold*** respectively.
172
173 To enable conceal use Vim's standard conceal configuration.
174
175 ```vim
176 set conceallevel=2
177 ```
178
179 To disable conceal regardless of `conceallevel` setting, add the following to your `.vimrc`:
180
181 ```vim
182 let g:vim_markdown_conceal = 0
183 ```
184
185 To disable math conceal with LaTeX math syntax enabled, add the following to your `.vimrc`:
186
187 ```vim
188 let g:tex_conceal = ""
189 let g:vim_markdown_math = 1
190 ```
191
192 ### Fenced code block languages
193
194 You can use filetype name as fenced code block languages for syntax highlighting.
195 If you want to use different name from filetype, you can add it in your `.vimrc` like so:
196
197 ```vim
198 let g:vim_markdown_fenced_languages = ['csharp=cs']
199 ```
200
201 This will cause the following to be highlighted using the `cs` filetype syntax.
202
203     ```csharp
204     ...
205     ```
206
207 Default is `['c++=cpp', 'viml=vim', 'bash=sh', 'ini=dosini']`.
208
209 ### Follow named anchors
210
211 This feature allows the `ge` command to follow named anchors in links of the form
212 `file#anchor` or just `#anchor`, where file may omit the `.md` extension as
213 usual. Two variables control its operation:
214
215 ```vim
216 let g:vim_markdown_follow_anchor = 1
217 ```
218
219 This tells vim-markdown whether to attempt to follow a named anchor in a link or
220 not. When it is 1, and only if a link can be split in two parts by the pattern
221 '#', then the first part is interpreted as the file and the second one as the
222 named anchor. This also includes urls of the form `#anchor`, for which the first
223 part is considered empty, meaning that the target file is the current one. After
224 the file is opened, the anchor will be searched.
225
226 Default is `0`.
227
228 ```vim
229 let g:vim_markdown_anchorexpr = "'<<'.v:anchor.'>>'"
230 ```
231
232 This expression will be evaluated substituting `v:anchor` with a quoted string
233 that contains the anchor to visit. The result of the evaluation will become the
234 real anchor to search in the target file. This is useful in order to convert
235 anchors of the form, say, `my-section-title` to searches of the form `My Section
236 Title` or `<<my-section-title>>`.
237
238 Default is `''`.
239
240 ### Syntax extensions
241
242 The following options control which syntax extensions will be turned on. They are off by default.
243
244 #### LaTeX math
245
246 Used as `$x^2$`, `$$x^2$$`, escapable as `\$x\$` and `\$\$x\$\$`.
247
248 ```vim
249 let g:vim_markdown_math = 1
250 ```
251
252 #### YAML Front Matter
253
254 Highlight YAML front matter as used by Jekyll or [Hugo](https://gohugo.io/content/front-matter/).
255
256 ```vim
257 let g:vim_markdown_frontmatter = 1
258 ```
259
260 #### TOML Front Matter
261
262 Highlight TOML front matter as used by [Hugo](https://gohugo.io/content/front-matter/).
263
264 TOML syntax highlight requires [vim-toml](https://github.com/cespare/vim-toml).
265
266 ```vim
267 let g:vim_markdown_toml_frontmatter = 1
268 ```
269
270 #### JSON Front Matter
271
272 Highlight JSON front matter as used by [Hugo](https://gohugo.io/content/front-matter/).
273
274 JSON syntax highlight requires [vim-json](https://github.com/elzr/vim-json).
275
276 ```vim
277 let g:vim_markdown_json_frontmatter = 1
278 ```
279
280 #### Strikethrough
281
282 Strikethrough uses two tildes. `~~Scratch this.~~`
283
284 ```vim
285 let g:vim_markdown_strikethrough = 1
286 ```
287
288 ### Adjust new list item indent
289
290 You can adjust a new list indent. For example, you insert a single line like below:
291
292 ```
293 * item1
294 ```
295
296 Then if you type `o` to insert new line in vim and type `* item2`, the result will be:
297
298 ```
299 * item1
300     * item2
301 ```
302
303 vim-markdown automatically insert the indent. By default, the number of spaces of indent is 4. If you'd like to change the number as 2, just write:
304
305 ```vim
306 let g:vim_markdown_new_list_item_indent = 2
307 ```
308
309 ### Do not require .md extensions for Markdown links
310
311 If you want to have a link like this `[link text](link-url)` and follow it for editing in vim using the `ge` command, but have it open the file "link-url.md" instead of the file "link-url", then use this option:
312
313 ```vim
314 let g:vim_markdown_no_extensions_in_markdown = 1
315 ```
316 This is super useful for GitLab and GitHub wiki repositories.
317
318 Normal behaviour would be that vim-markup required you to do this `[link text](link-url.md)`, but this is not how the Gitlab and GitHub wiki repositories work. So this option adds some consistency between the two. 
319
320 ### Auto-write when following link
321
322 If you follow a link like this `[link text](link-url)` using the `ge` shortcut, this option will automatically save any edits you made before moving you:
323
324 ```vim
325 let g:vim_markdown_autowrite = 1
326 ```
327
328 ### Change default file extension
329
330 If you would like to use a file extension other than `.md` you may do so using the `vim_markdown_auto_extension_ext` variable:
331
332 ```vim
333 let g:vim_markdown_auto_extension_ext = 'txt'
334 ```
335
336 ### Do not automatically insert bulletpoints
337
338 Automatically inserting bulletpoints can lead to problems when wrapping text
339 (see issue #232 for details), so it can be disabled:
340
341 ```vim
342 let g:vim_markdown_auto_insert_bullets = 0
343 ```
344
345 In that case, you probably also want to set the new list item indent to 0 as
346 well, or you will have to remove an indent each time you add a new list item:
347
348 ```vim
349 let g:vim_markdown_new_list_item_indent = 0
350 ```
351
352 ### Change how to open new files
353
354 By default when following a link the target file will be opened in your current buffer.  This behavior can change if you prefer using splits or tabs by using the `vim_markdown_edit_url_in` variable.  Possible values are `tab`, `vsplit`, `hsplit`, `current` opening in a new tab, vertical split, horizontal split, and current buffer respectively.  Defaults to current buffer if not set:
355
356 ```vim
357 let g:vim_markdown_edit_url_in = 'tab'
358 ```
359
360 ## Mappings
361
362 The following work on normal and visual modes:
363
364 -   `gx`: open the link under the cursor in the same browser as the standard `gx` command. `<Plug>Markdown_OpenUrlUnderCursor`
365
366     The standard `gx` is extended by allowing you to put your cursor anywhere inside a link.
367
368     For example, all the following cursor positions will work:
369
370         [Example](http://example.com)
371         ^  ^    ^^   ^       ^
372         1  2    34   5       6
373
374         <http://example.com>
375         ^  ^               ^
376         1  2               3
377
378     Known limitation: does not work for links that span multiple lines.
379
380 -   `ge`: open the link under the cursor in Vim for editing. Useful for relative markdown links. `<Plug>Markdown_EditUrlUnderCursor`
381
382     The rules for the cursor position are the same as the `gx` command.
383
384 -   `]]`: go to next header. `<Plug>Markdown_MoveToNextHeader`
385
386 -   `[[`: go to previous header. Contrast with `]c`. `<Plug>Markdown_MoveToPreviousHeader`
387
388 -   `][`: go to next sibling header if any. `<Plug>Markdown_MoveToNextSiblingHeader`
389
390 -   `[]`: go to previous sibling header if any. `<Plug>Markdown_MoveToPreviousSiblingHeader`
391
392 -   `]c`: go to Current header. `<Plug>Markdown_MoveToCurHeader`
393
394 -   `]u`: go to parent header (Up). `<Plug>Markdown_MoveToParentHeader`
395
396 This plugin follows the recommended Vim plugin mapping interface, so to change the map `]u` to `asdf`, add to your `.vimrc`:
397
398     map asdf <Plug>Markdown_MoveToParentHeader
399
400 To disable a map use:
401
402     map <Plug> <Plug>Markdown_MoveToParentHeader
403
404 ## Commands
405
406 The following requires `:filetype plugin on`.
407
408 -   `:HeaderDecrease`:
409
410     Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc.
411
412     If range is given, only operate in the range.
413
414     If an `h1` would be decreased, abort.
415
416     For simplicity of implementation, Setex headers are converted to Atx.
417
418 -   `:HeaderIncrease`: Analogous to `:HeaderDecrease`, but increase levels instead.
419
420 -   `:SetexToAtx`:
421
422     Convert all Setex style headers in buffer to Atx.
423
424     If a range is given, e.g. hit `:` from visual mode, only operate on the range.
425
426 -   `:TableFormat`: Format the table under the cursor [like this](http://www.cirosantilli.com/markdown-style-guide/#tables).
427
428     Requires [Tabular](https://github.com/godlygeek/tabular).
429
430     The input table *must* already have a separator line as the second line of the table.
431     That line only needs to contain the correct pipes `|`, nothing else is required.
432
433 -   `:Toc`: create a quickfix vertical window navigable table of contents with the headers.
434
435     Hit `<Enter>` on a line to jump to the corresponding line of the markdown file.
436
437 -   `:Toch`: Same as `:Toc` but in an horizontal window.
438
439 -   `:Toct`: Same as `:Toc` but in a new tab.
440
441 -   `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `:Tocv`.
442
443 ## Credits
444
445 The main contributors of vim-markdown are:
446
447 - **Ben Williams** (A.K.A. **plasticboy**). The original developer of vim-markdown. [Homepage](http://plasticboy.com/).
448
449 If you feel that your name should be on this list, please make a pull request listing your contributions.
450
451 ## License
452
453 The MIT License (MIT)
454
455 Copyright (c) 2012 Benjamin D. Williams
456
457 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
458
459 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
460
461 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.