]>
git.madduck.net Git - etc/vim.git/blobdiff - 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:
+[](https://travis-ci.org/plasticboy/vim-markdown)
+
Syntax highlighting, matching rules and mappings for [the original Markdown](http://daringfireball.net/projects/markdown/) and extensions.
## Installation
If you use [Vundle](https://github.com/gmarik/vundle), add the following line to your `~/.vimrc`:
Syntax highlighting, matching rules and mappings for [the original Markdown](http://daringfireball.net/projects/markdown/) and extensions.
## Installation
If you use [Vundle](https://github.com/gmarik/vundle), add the following line to your `~/.vimrc`:
+ Plugin 'godlygeek/tabular'
Plugin 'plasticboy/vim-markdown'
Plugin 'plasticboy/vim-markdown'
-And then run inside Vim:
+The `tabular` plugin come *before* `vim-markdown`.
+
+Then run inside Vim:
:so ~/.vimrc
:PluginInstall
:so ~/.vimrc
:PluginInstall
let g:vim_markdown_no_default_key_mappings=1
```
let g:vim_markdown_no_default_key_mappings=1
```
+**Syntax extensions**
+
+The following options control which syntax extensions will be turned on.
+
+LaTeX math: `$ $`, `$$ $$`, escapable as `\$ \$` and `\$\$ \$\$`:
+
+```vim
+let g:vim_markdown_math=1
+```
## Mappings
The following work on normal and visual modes:
## Mappings
The following work on normal and visual modes:
-- `:Toc`: create a quickfix vertical window navigable table of contents with the headers.
- Hit `<Enter>` on a line to jump to the corresponding line of the markdown file .
+ Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc .
-- `:Toch`: Same as `:Toc` but in an horizontal window.
-- `:Toct`: Same as `:Toc` but in a new tab.
-- `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `Tocv`.
+ If range is given, only operate in the range.
+
+ If an `h1` would be decreased, abort.
+
+ For simplicity of implementation, Setex headers are converted to Atx.
+
+- `:HeaderIncrease`: Analogous to `:HeaderDecrease`, but increase levels instead.
If a range is given, e.g. hit `:` from visual mode, only operate on the range.
If a range is given, e.g. hit `:` from visual mode, only operate on the range.
+- `:TableFormat`: Format the table under the cursor [like this](http://www.cirosantilli.com/markdown-styleguide/#tables).
- Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc .
+ Requires [Tabular](https://github.com/godlygeek/tabular) .
- If range is given, only operate in the range.
+ The input table *must* already have a separator line as the second line of the table.
+ That line only needs to contain the correct pipes `|`, nothing else is required.
- If an `h1` would be decreased, abort .
+- `:Toc`: create a quickfix vertical window navigable table of contents with the headers .
- For simplicity of implementation, Setex headers are converted to Atx .
+ Hit `<Enter>` on a line to jump to the corresponding line of the markdown file .
-- `:HeaderIncrease`: Analogous to `:HeaderDecrease`, but increase levels instead.
+- `:Toch`: Same as `:Toc` but in an horizontal window.
+
+- `:Toct`: Same as `:Toc` but in a new tab.
+
+- `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `Tocv`.
projects / etc / vim.git / blobdiff