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

c1289f57d9244764593f797fa90ee4c9bb54651c
[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. [Options](#options)
9 1. [Mappings](#mappings)
10 1. [Commands](#commands)
11 1. [Credits](#credits)
12 1. [License](#license)
13
14 ## Installation
15
16 If you use [Vundle](https://github.com/gmarik/vundle), add the following line to your `~/.vimrc`:
17
18 ```vim
19 Plugin 'godlygeek/tabular'
20 Plugin 'plasticboy/vim-markdown'
21 ```
22
23 The `tabular` plugin must come *before* `vim-markdown`.
24
25 Then run inside Vim:
26
27 ```vim
28 :so ~/.vimrc
29 :PluginInstall
30 ```
31
32 If you use [Pathogen](https://github.com/tpope/vim-pathogen), do this:
33
34 ```sh
35 cd ~/.vim/bundle
36 git clone https://github.com/plasticboy/vim-markdown.git
37 ```
38
39 To install without Pathogen using the Debian [vim-addon-manager](http://packages.qa.debian.org/v/vim-addon-manager.html), do this:
40
41 ```sh
42 git clone https://github.com/plasticboy/vim-markdown.git
43 cd vim-markdown
44 sudo make install
45 vim-addon-manager install markdown
46 ```
47
48 If you are not using any package manager, download the [tarball](https://github.com/plasticboy/vim-markdown/archive/master.tar.gz) and do this:
49
50 ```sh
51 cd ~/.vim
52 tar --strip=1 -zxf vim-markdown-master.tar.gz
53 ```
54
55 ## Options
56
57 ### Disable Folding
58
59 Add the following line to your `.vimrc` to disable the folding configuration:
60
61 ```vim
62 let g:vim_markdown_folding_disabled = 1
63 ```
64
65 This option only controls Vim Markdown specific folding configuration.
66
67 To enable/disable folding use Vim's standard folding configuration.
68
69 ```vim
70 set [no]foldenable
71 ```
72
73 ### Change fold style
74
75 To fold in a style like [python-mode](https://github.com/klen/python-mode), add the following to your `.vimrc`:
76
77 ```vim
78 let g:vim_markdown_folding_style_pythonic = 1
79 ```
80
81 Level 1 heading which is served as a document title is not folded.
82 `g:vim_markdown_folding_level` setting is not active with this fold style.
83
84 ### Set header folding level
85
86 Folding level is a number between 1 and 6. By default, if not specified, it is set to 1.
87
88 ```vim
89 let g:vim_markdown_folding_level = 6
90 ```
91
92 Tip: it can be changed on the fly with:
93
94 ```vim
95 :let g:vim_markdown_folding_level = 1
96 :edit
97 ```
98
99 ### Disable Default Key Mappings
100
101 Add the following line to your `.vimrc` to disable default key mappings:
102
103 ```vim
104 let g:vim_markdown_no_default_key_mappings = 1
105 ```
106
107 You can also map them by yourself with `<Plug>` mappings.
108
109 ### Enable TOC window auto-fit
110
111 Allow for the TOC window to auto-fit when it's possible for it to shrink.
112 It never increases its default size (half screen), it only shrinks.
113
114 ```vim
115 let g:vim_markdown_toc_autofit = 1
116 ```
117
118 ### Text emphasis restriction to single-lines
119
120 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 (ie, for it to be applied a closing token must be found on the same line). To do so:
121
122 ```vim
123 let g:vim_markdown_emphasis_multiline = 0
124 ```
125
126 ### Syntax Concealing
127
128 Concealing is set for some syntax.
129
130 For example, conceal `[link text](link url)` as just `link text`.
131
132 To enable conceal use Vim's standard conceal configuration.
133
134 ```vim
135 set conceallevel=2
136 ```
137
138 To disable conceal regardless of `conceallevel` setting, add the following to your `.vimrc`:
139
140 ```vim
141 let g:vim_markdown_conceal = 0
142 ```
143
144 ### Fenced code block languages
145
146 You can use filetype name as fenced code block languages for syntax highlighting.
147 If you want to use different name from filetype, you can add it in your `.vimrc` like so:
148
149 ```vim
150 let g:vim_markdown_fenced_languages = ['csharp=cs']
151 ```
152
153 This will cause the following to be highlighted using the `cs` filetype syntax.
154
155     ```csharp
156     ...
157     ```
158
159 Default is `['c++=cpp', 'viml=vim', 'bash=sh', 'ini=dosini']`.
160
161 ### Syntax extensions
162
163 The following options control which syntax extensions will be turned on. They are off by default.
164
165 #### LaTeX math
166
167 Used as `$x^2$`, `$$x^2$$`, escapable as `\$x\$` and `\$\$x\$\$`.
168
169 ```vim
170 let g:vim_markdown_math = 1
171 ```
172
173 #### YAML Front Matter
174
175 Highlight YAML front matter as used by Jekyll or [Hugo](https://gohugo.io/content/front-matter/).
176
177 ```vim
178 let g:vim_markdown_frontmatter = 1
179 ```
180
181 #### TOML Front Matter
182
183 Highlight TOML front matter as used by [Hugo](https://gohugo.io/content/front-matter/).
184
185 TOML syntax highlight requires [vim-toml](https://github.com/cespare/vim-toml).
186
187 ```vim
188 let g:vim_markdown_toml_frontmatter = 1
189 ```
190
191 #### JSON Front Matter
192
193 Highlight JSON front matter as used by [Hugo](https://gohugo.io/content/front-matter/).
194
195 JSON syntax highlight requires [vim-json](https://github.com/elzr/vim-json).
196
197 ```vim
198 let g:vim_markdown_json_frontmatter = 1
199 ```
200
201 ### Adjust new list item indent
202
203 You can adjust a new list indent. For example, you insert a single line like below:
204
205 ```
206 * item1
207 ```
208
209 Then if you type `o` to insert new line in vim and type `* item2`, the result will be:
210
211 ```
212 * item1
213     * item2
214 ```
215
216 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:
217
218 ```vim
219 let g:vim_markdown_new_list_item_indent = 2
220 ```
221
222 ### Do not require .md extensions for Markdown links
223
224 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:
225
226 ```vim
227 let g:vim_markdown_no_extensions_in_markdown = 1
228 ```
229 This is super useful for GitLab and GitHub wiki repositories.
230
231 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. 
232
233
234 ## Mappings
235
236 The following work on normal and visual modes:
237
238 -   `gx`: open the link under the cursor in the same browser as the standard `gx` command. `<Plug>Markdown_OpenUrlUnderCursor`
239
240     The standard `gx` is extended by allowing you to put your cursor anywhere inside a link.
241
242     For example, all the following cursor positions will work:
243
244         [Example](http://example.com)
245         ^  ^    ^^   ^       ^
246         1  2    34   5       6
247
248         <http://example.com>
249         ^  ^               ^
250         1  2               3
251
252     Known limitation: does not work for links that span multiple lines.
253
254 -   `ge`: open the link under the cursor in Vim for editing. Useful for relative markdown links. `<Plug>Markdown_EditUrlUnderCursor`
255
256     The rules for the cursor position are the same as the `gx` command.
257
258 -   `]]`: go to next header. `<Plug>Markdown_MoveToNextHeader`
259
260 -   `[[`: go to previous header. Contrast with `]c`. `<Plug>Markdown_MoveToPreviousHeader`
261
262 -   `][`: go to next sibling header if any. `<Plug>Markdown_MoveToNextSiblingHeader`
263
264 -   `[]`: go to previous sibling header if any. `<Plug>Markdown_MoveToPreviousSiblingHeader`
265
266 -   `]c`: go to Current header. `<Plug>Markdown_MoveToCurHeader`
267
268 -   `]u`: go to parent header (Up). `<Plug>Markdown_MoveToParentHeader`
269
270 This plugin follows the recommended Vim plugin mapping interface, so to change the map `]u` to `asdf`, add to your `.vimrc`:
271
272     map asdf <Plug>Markdown_MoveToParentHeader
273
274 To disable a map use:
275
276     map <Plug> <Plug>Markdown_MoveToParentHeader
277
278 ## Commands
279
280 The following requires `:filetype plugin on`.
281
282 -   `:HeaderDecrease`:
283
284     Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc.
285
286     If range is given, only operate in the range.
287
288     If an `h1` would be decreased, abort.
289
290     For simplicity of implementation, Setex headers are converted to Atx.
291
292 -   `:HeaderIncrease`: Analogous to `:HeaderDecrease`, but increase levels instead.
293
294 -   `:SetexToAtx`:
295
296     Convert all Setex style headers in buffer to Atx.
297
298     If a range is given, e.g. hit `:` from visual mode, only operate on the range.
299
300 -   `:TableFormat`: Format the table under the cursor [like this](http://www.cirosantilli.com/markdown-style-guide/#tables).
301
302     Requires [Tabular](https://github.com/godlygeek/tabular).
303
304     The input table *must* already have a separator line as the second line of the table.
305     That line only needs to contain the correct pipes `|`, nothing else is required.
306
307 -   `:Toc`: create a quickfix vertical window navigable table of contents with the headers.
308
309     Hit `<Enter>` on a line to jump to the corresponding line of the markdown file.
310
311 -   `:Toch`: Same as `:Toc` but in an horizontal window.
312
313 -   `:Toct`: Same as `:Toc` but in a new tab.
314
315 -   `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `:Tocv`.
316
317 ## Credits
318
319 The main contributors of vim-markdown are:
320
321 - **Ben Williams** (A.K.A. **plasticboy**). The original developer of vim-markdown. [Homepage](http://plasticboy.com/).
322
323 If you feel that your name should be on this list, please make a pull request listing your contributions.
324
325 ## License
326
327 The MIT License (MIT)
328
329 Copyright (c) 2012 Benjamin D. Williams
330
331 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:
332
333 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
334
335 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.