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

55baaa592e13e233ac4b001f50de6b66b2d67cc6
[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
76 the following to your `.vimrc`:
77
78 ```vim
79 let g:vim_markdown_folding_style_pythonic=1
80 ```
81
82 ### Disable Default Key Mappings
83
84 Add the following line to your `.vimrc` to disable default key mappings:
85
86 ```vim
87 let g:vim_markdown_no_default_key_mappings=1
88 ```
89
90 You can also map them by yourself with `<Plug>` mappings.
91
92 ### Syntax extensions
93
94 The following options control which syntax extensions will be turned on. They are off by default.
95
96 #### LaTeX math
97
98 Used as `$x^2$`, `$$x^2$$`, escapable as `\$x\$` and `\$\$x\$\$`.
99
100 ```vim
101 let g:vim_markdown_math=1
102 ```
103
104 #### YAML frontmatter
105
106 Highlight YAML frontmatter as used by Jekyll:
107
108 ```vim
109 let g:vim_markdown_frontmatter=1
110 ```
111
112 ## Mappings
113
114 The following work on normal and visual modes:
115
116 -   `gx`: open the link under the cursor in the same browser as the standard `gx` command. `<Plug>Markdown_OpenUrlUnderCursor`
117
118     The standard `gx` is extended by allowing you to put your cursor anywhere inside a link.
119
120     For example, all the following cursor positions will work:
121
122         [Example](http://example.com)
123         ^  ^    ^^   ^       ^
124         1  2    34   5       6
125
126         <http://example.com>
127         ^  ^               ^
128         1  2               3
129
130     Known limitation: does not work for links that span multiple lines.
131
132 -   `]]`: go to next header. `<Plug>Markdown_MoveToNextHeader`
133
134 -   `[[`: go to previous header. Contrast with `]c`. `<Plug>Markdown_MoveToPreviousHeader`
135
136 -   `][`: go to next sibling header if any. `<Plug>Markdown_MoveToNextSiblingHeader`
137
138 -   `[]`: go to previous sibling header if any. `<Plug>Markdown_MoveToPreviousSiblingHeader`
139
140 -   `]c`: go to Current header. `<Plug>Markdown_MoveToCurHeader`
141
142 -   `]u`: go to parent header (Up). `<Plug>Markdown_MoveToParentHeader`
143
144 This plugin follows the recommended Vim plugin mapping interface, so to change the map `]u` to `asdf`, add to your `.vimrc`:
145
146     map asdf <Plug>Markdown_MoveToParentHeader
147
148 To disable a map use:
149
150     map <Plug> <Plug>Markdown_MoveToParentHeader
151
152 ## Commands
153
154 -   `:HeaderDecrease`:
155
156     Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc.
157
158     If range is given, only operate in the range.
159
160     If an `h1` would be decreased, abort.
161
162     For simplicity of implementation, Setex headers are converted to Atx.
163
164 -   `:HeaderIncrease`: Analogous to `:HeaderDecrease`, but increase levels instead.
165
166 -   `:SetexToAtx`:
167
168     Convert all Setex style headers in buffer to Atx.
169
170     If a range is given, e.g. hit `:` from visual mode, only operate on the range.
171
172 -   `:TableFormat`: Format the table under the cursor [like this](http://www.cirosantilli.com/markdown-styleguide/#tables).
173
174     Requires [Tabular](https://github.com/godlygeek/tabular).
175
176     The input table *must* already have a separator line as the second line of the table.
177     That line only needs to contain the correct pipes `|`, nothing else is required.
178
179 -   `:Toc`: create a quickfix vertical window navigable table of contents with the headers.
180
181     Hit `<Enter>` on a line to jump to the corresponding line of the markdown file.
182
183 -   `:Toch`: Same as `:Toc` but in an horizontal window.
184
185 -   `:Toct`: Same as `:Toc` but in a new tab.
186
187 -   `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `Tocv`.
188
189 ## Credits
190
191 The main contributors of vim-markdown are:
192
193 - **Ben Williams** (A.K.A. **plasticboy**). The original developer of vim-markdown. [Homepage](http://plasticboy.com/).
194
195 If you feel that your name should be on this list, please make a pull request listing your contributions.
196
197 ## License
198
199 The MIT License (MIT)
200
201 Copyright (c) 2012 Benjamin D. Williams
202
203 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:
204
205 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
206
207 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.