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

Allow users to disable individual maps with hasmapto checks
[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 ## Installation
8
9 If you use [Vundle](https://github.com/gmarik/vundle), add the following line to your `~/.vimrc`:
10
11 ```vim
12 Plugin 'godlygeek/tabular'
13 Plugin 'plasticboy/vim-markdown'
14 ```
15
16 The `tabular` plugin must come *before* `vim-markdown`.
17
18 Then run inside Vim:
19
20 ```vim
21 :so ~/.vimrc
22 :PluginInstall
23 ```
24
25 If you use [Pathogen](https://github.com/tpope/vim-pathogen), do this:
26
27 ```sh
28 cd ~/.vim/bundle
29 git clone https://github.com/plasticboy/vim-markdown.git
30 ```
31
32 To install without Pathogen using the Debian [vim-addon-manager](http://packages.qa.debian.org/v/vim-addon-manager.html), do this:
33
34 ```sh
35 git clone https://github.com/plasticboy/vim-markdown.git
36 cd vim-markdown
37 sudo make install
38 vim-addon-manager install mkd
39 ```
40
41 If you are not using any package manager, download the [tarball](https://github.com/plasticboy/vim-markdown/archive/master.tar.gz) and do this:
42
43 ```sh
44 cd ~/.vim
45 tar --strip=1 -zxf vim-markdown-master.tar.gz
46 ```
47
48 ## Options
49
50 ### Disable Folding
51
52 Add the following line to your `.vimrc` to disable the folding configuration:
53
54 ```vim
55 let g:vim_markdown_folding_disabled=1
56 ```
57
58 This option only controls Vim Markdown specific folding configuration.
59
60 To enable/disable folding use Vim's standard folding configuration.
61
62 ```vim
63 set [no]foldenable
64 ```
65
66 ### Disable Default Key Mappings
67
68 Add the following line to your `.vimrc` to disable default key mappings:
69
70 ```vim
71 let g:vim_markdown_no_default_key_mappings=1
72 ```
73
74 You can also map them by yourself with `<Plug>` mappings.
75
76 ### Syntax extensions
77
78 The following options control which syntax extensions will be turned on. They are off by default.
79
80 #### LaTeX math
81
82 Used as `$x^2$`, `$$x^2$$`, escapable as `\$x\$` and `\$\$x\$\$`.
83
84 ```vim
85 let g:vim_markdown_math=1
86 ```
87
88 #### YAML frontmatter
89
90 Highlight YAML frontmatter as used by Jekyll:
91
92 ```vim
93 let g:vim_markdown_frontmatter=1
94 ```
95
96 ## Mappings
97
98 The following work on normal and visual modes:
99
100 -   `gx`: open the link under the cursor in the same browser as the standard `gx` command.
101
102     The standard `gx` is extended by allowing you to put your cursor anywhere inside a link.
103
104     For example, all the following cursor positions will work:
105
106         [Example](http://example.com)
107         ^  ^    ^^   ^       ^
108         1  2    34   5       6
109
110         <http://example.com>
111         ^  ^               ^
112         1  2               3
113
114     Known limitation: does not work for links that span multiple lines.
115
116 -   `]]`: go to next header. `<Plug>Markdown_MoveToNextHeader`
117
118 -   `[[`: go to previous header. Contrast with `]c`. `<Plug>Markdown_MoveToPreviousHeader`
119
120 -   `][`: go to next sibling header if any. `<Plug>Markdown_MoveToNextSiblingHeader`
121
122 -   `[]`: go to previous sibling header if any. `<Plug>Markdown_MoveToPreviousSiblingHeader`
123
124 -   `]c`: go to Current header. `<Plug>Markdown_MoveToCurHeader`
125
126 -   `]u`: go to parent header (Up). `<Plug>Markdown_MoveToParentHeader`
127
128 This plugging follows the recommended Vim plugin mapping interface, so if you want to change the map `]u` to `asdf`, add to your `.vimrc`:
129
130     map asdf <Plug>Markdown_MoveToParentHeader
131
132 To disable a map, use:
133
134     map <Plug> <Plug>Markdown_MoveToParentHeader
135
136 ## Commands
137
138 -   `:HeaderDecrease`:
139
140     Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc.
141
142     If range is given, only operate in the range.
143
144     If an `h1` would be decreased, abort.
145
146     For simplicity of implementation, Setex headers are converted to Atx.
147
148 -   `:HeaderIncrease`: Analogous to `:HeaderDecrease`, but increase levels instead.
149
150 -   `:SetexToAtx`:
151
152     Convert all Setex style headers in buffer to Atx.
153
154     If a range is given, e.g. hit `:` from visual mode, only operate on the range.
155
156 -   `:TableFormat`: Format the table under the cursor [like this](http://www.cirosantilli.com/markdown-styleguide/#tables).
157
158     Requires [Tabular](https://github.com/godlygeek/tabular).
159
160     The input table *must* already have a separator line as the second line of the table.
161     That line only needs to contain the correct pipes `|`, nothing else is required.
162
163 -   `:Toc`: create a quickfix vertical window navigable table of contents with the headers.
164
165     Hit `<Enter>` on a line to jump to the corresponding line of the markdown file.
166
167 -   `:Toch`: Same as `:Toc` but in an horizontal window.
168
169 -   `:Toct`: Same as `:Toc` but in a new tab.
170
171 -   `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `Tocv`.
172
173 ## Credits
174
175 The main contributors of vim-markdown are:
176
177 - **Ben Williams** (A.K.A. **plasticboy**). The original developer of vim-markdown. [Homepage](http://plasticboy.com/).
178
179 If you feel that your name should be on this list, please make a pull request listing your contributions.
180
181 ## License
182
183 The MIT License (MIT)
184
185 Copyright (c) 2012 Benjamin D. Williams
186
187 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:
188
189 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
190
191 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.