Merge pull request #158 from nybblr/nybblr/add-tilde-code-blocks

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index 7d75420f30e4edcda9df0cedb2b782d7e3f7757b..334f898a508f5523a49c8ee77c99b381926f84c3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,54 +1,67 @@
 # 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'
+```vim
+Plugin 'godlygeek/tabular'
+Plugin 'plasticboy/vim-markdown'
+```
 
-And then run inside Vim:
+The `tabular` plugin must come *before* `vim-markdown`.
 
-    :so ~/.vimrc
-    :BundleInstall
+Then run inside Vim:
+
+```vim
+:so ~/.vimrc
+:PluginInstall
+```
 
 If you use [Pathogen](https://github.com/tpope/vim-pathogen), do this:
 
-    $ cd ~/.vim/bundle
-    $ git clone https://github.com/plasticboy/vim-markdown.git
+```sh
+cd ~/.vim/bundle
+git clone https://github.com/plasticboy/vim-markdown.git
+```
 
 To install without Pathogen using the Debian [vim-addon-manager](http://packages.qa.debian.org/v/vim-addon-manager.html), do this:
 
-    $ git clone https://github.com/plasticboy/vim-markdown.git
-    $ cd vim-markdown
-    $ sudo make install
-    $ vim-addon-manager install mkd
+```sh
+git clone https://github.com/plasticboy/vim-markdown.git
+cd vim-markdown
+sudo make install
+vim-addon-manager install mkd
+```
 
 If you are not using any package manager, download the [tarball](https://github.com/plasticboy/vim-markdown/archive/master.tar.gz) and do this:
 
-    $ cd ~/.vim
-    $ tar --strip=1 -zxf vim-markdown-master.tar.gz
+```sh
+cd ~/.vim
+tar --strip=1 -zxf vim-markdown-master.tar.gz
+```
 
 ## Options
 
-**Disable Folding**
+### Disable Folding
 
-Add the following line to your `.vimrc` to disable folding.
+Add the following line to your `.vimrc` to disable folding configuration.
 
 ```vim
 let g:vim_markdown_folding_disabled=1
 ```
 
-**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.
+This option only controls vim_markdown's folding configuration. To enable/disable folding use Vim's folding configuration.
 
 ```vim
-let g:vim_markdown_initial_foldlevel=1
+set [no]foldenable
 ```
 
-**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.
 
@@ -56,6 +69,26 @@ Add the following line to your `.vimrc` to disable default key mappings. You can
 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
+
+Highlight YAML frontmatter as used by Jekyll:
+
+```vim
+let g:vim_markdown_frontmatter=1
+```
+
 ## Mappings
 
 The following work on normal and visual modes:
@@ -69,13 +102,17 @@ The following work on normal and visual modes:
 
 ## Commands
 
-- `:Toc`: create a quickfix vertical window navigable table of contents with the headers.
+- `:HeaderDecrease`:
 
-    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.
 
 - `:SetexToAtx`:
 
@@ -83,17 +120,22 @@ The following work on normal and visual modes:
 
     If a range is given, e.g. hit `:` from visual mode, only operate on the range.
 
-- `:HeaderDecrease`:
+- `: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`.
 
 ## Credits