X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/290d61b8387ae5bb6b471b643127aa568e55a77e..f8bd8714e62678851f97c1ae88633d59d24118c2:/README.md

diff --git a/README.md b/README.md
index b004bbc..2b23477 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,22 @@
 # Markdown Vim Mode
 
+[![Build Status](https://travis-ci.org/plasticboy/vim-markdown.svg)](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`:
 
-    Bundle 'plasticboy/vim-markdown'
+    Plugin 'godlygeek/tabular'
+    Plugin 'plasticboy/vim-markdown'
+
+The `tabular` plugin come *before* `vim-markdown`.
 
-And then run inside Vim:
+Then run inside Vim:
 
     :so ~/.vimrc
-    :BundleInstall
+    :PluginInstall
 
 If you use [Pathogen](https://github.com/tpope/vim-pathogen), do this:
 
@@ -32,7 +37,7 @@ If you are not using any package manager, download the [tarball](https://github.
 
 ## Options
 
-**Disable Folding**
+### Disable Folding
 
 Add the following line to your `.vimrc` to disable folding.
 
@@ -40,7 +45,7 @@ Add the following line to your `.vimrc` to disable folding.
 let g:vim_markdown_folding_disabled=1
 ```
 
-**Set Initial Foldlevel**
+### Set Initial Foldlevel
 
 Add the following line to your `.vimrc` to set the initial foldlevel. This option defaults to 0 (i.e. all folds are closed) and is ignored if folding is disabled.
 
@@ -48,12 +53,32 @@ Add the following line to your `.vimrc` to set the initial foldlevel. This optio
 let g:vim_markdown_initial_foldlevel=1
 ```
 
-**Disable Default Key Mappings**
+### Disable Default Key Mappings
+
+Add the following line to your `.vimrc` to disable default key mappings. You can map them by yourself with `<Plug>` mappings.
+
+```vim
+let g:vim_markdown_no_default_key_mappings=1
+```
+
+### Syntax extensions
+
+The following options control which syntax extensions will be turned on. They are off by default.
+
+#### LaTeX math
+
+Used as `$x^2$`, `$$x^2$$`, escapable as `\$x\$` and `\$\$x\$\$`.
+
+```vim
+let g:vim_markdown_math=1
+```
+
+#### YAML frontmatter
 
-Add the following line to your `.vimrc` to disable default key mappings. You can map them by yourself with `<Plug>` mappings
+Highlight YAML frontmatter as used by Jekyll:
 
 ```vim
-let g:markdown_no_default_key_mappings=1
+let g:vim_markdown_frontmatter=1
 ```
 
 ## Mappings
@@ -69,14 +94,39 @@ The following work on normal and visual modes:
 
 ## Commands
 
-The following commands currently only work for atx style headers (`#`). Pull request are welcome to extend them to Setext style headers (`===`).
+- `:HeaderDecrease`:
+
+    Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc.
+
+    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.
+
+- `:SetexToAtx`:
+
+    Convert all Setex style headers in buffer to Atx.
+
+    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).
+
+    Requires [Tabular](https://github.com/godlygeek/tabular).
+
+    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.
 
 - `: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.
 
 - `: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`.
 
 ## Credits