Merge pull request #178 from cirosantilli/readme-format

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index 9583a4385b1e4ada0e140c26f6e3e3d239f303d6..41629a15f4afae5ce8891099453a7052d8016850 100644 (file)
--- a/README.md
+++ b/README.md
@@ -8,65 +8,71 @@ Syntax highlighting, matching rules and mappings for [the original Markdown](htt
 
 If you use [Vundle](https://github.com/gmarik/vundle), add the following line to your `~/.vimrc`:
 
-    Plugin 'godlygeek/tabular'
-    Plugin 'plasticboy/vim-markdown'
+```vim
+Plugin 'godlygeek/tabular'
+Plugin 'plasticboy/vim-markdown'
+```
 
-The `tabular` plugin come *before* `vim-markdown`.
+The `tabular` plugin must come *before* `vim-markdown`.
 
 Then run inside Vim:
 
-    :so ~/.vimrc
-    :PluginInstall
+```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
 
-Add the following line to your `.vimrc` to disable folding configuration.
+Add the following line to your `.vimrc` to disable the folding configuration:
 
 ```vim
 let g:vim_markdown_folding_disabled=1
 ```
 
-This option only controls vim_markdown's folding configuration. To enable/disable folding use Vim's folding configuration.
+This option only controls Vim Markdown specific folding configuration.
 
-```vim
-set [no]foldenable
-```
-
-### 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.
+To enable/disable folding use Vim's standard folding configuration.
 
 ```vim
-let g:vim_markdown_initial_foldlevel=1
+set [no]foldenable
 ```
 
 ### 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.
+Add the following line to your `.vimrc` to disable default key mappings:
 
 ```vim
 let g:vim_markdown_no_default_key_mappings=1
 ```
 
+You can also map them by yourself with `<Plug>` mappings.
+
 ### Syntax extensions
 
 The following options control which syntax extensions will be turned on. They are off by default.
@@ -100,7 +106,7 @@ The following work on normal and visual modes:
 
 ## Commands
 
-- `:HeaderDecrease`:
+-   `:HeaderDecrease`:
 
     Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc.
 
@@ -110,30 +116,30 @@ The following work on normal and visual modes:
 
     For simplicity of implementation, Setex headers are converted to Atx.
 
-- `:HeaderIncrease`: Analogous to `:HeaderDecrease`, but increase levels instead.
+-   `:HeaderIncrease`: Analogous to `:HeaderDecrease`, but increase levels instead.
 
-- `:SetexToAtx`:
+-   `: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).
+-   `: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.
+-   `: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.
+-   `:Toch`: Same as `:Toc` but in an horizontal window.
 
-- `:Toct`: Same as `:Toc` but in a new tab.
+-   `:Toct`: Same as `:Toc` but in a new tab.
 
-- `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `Tocv`.
+-   `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `Tocv`.
 
 ## Credits