Merge pull request #433 from nstickney/master

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index 67d473cc4204caf71f9b6af51f2b5828041924e4..9f93316cb94d258372d49a6d661dca13dddf81b2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,6 +5,7 @@
 Syntax highlighting, matching rules and mappings for [the original Markdown](http://daringfireball.net/projects/markdown/) and extensions.
 
 1. [Installation](#installation)
+1. [Basic usage](#basic-usage)
 1. [Options](#options)
 1. [Mappings](#mappings)
 1. [Commands](#commands)
@@ -13,7 +14,7 @@ Syntax highlighting, matching rules and mappings for [the original Markdown](htt
 
 ## Installation
 
-If you use [Vundle](https://github.com/gmarik/vundle), add the following line to your `~/.vimrc`:
+If you use [Vundle](https://github.com/gmarik/vundle), add the following lines to your `~/.vimrc`:
 
 ```vim
 Plugin 'godlygeek/tabular'
@@ -52,6 +53,37 @@ cd ~/.vim
 tar --strip=1 -zxf vim-markdown-master.tar.gz
 ```
 
+## Basic usage
+
+### Folding
+
+Folding is enabled for headers by default.
+
+The following commands are useful to open and close folds:
+
+- `zr`: reduces fold level throughout the buffer
+- `zR`: opens all folds
+- `zm`: increases fold level throughout the buffer
+- `zM`: folds everything all the way
+- `za`: open a fold your cursor is on
+- `zA`: open a fold your cursor is on recursively
+- `zc`: close a fold your cursor is on
+- `zC`: close a fold your cursor is on recursively
+
+[Options](#options) are available to disable folding or change folding style.
+
+Try `:help fold-expr` and `:help fold-commands` for details.
+
+### Concealing
+
+Concealing is set for some syntax such as bold, italic, code block and link.
+
+Concealing lets you conceal text with other text. The actual source text is not modified. If you put your cursor on the concealed line, the conceal goes away.
+
+[Options](#options) are available to disable or change concealing.
+
+Try `:help concealcursor` and `:help conceallevel` for details.
+
 ## Options
 
 ### Disable Folding
@@ -123,7 +155,7 @@ let g:vim_markdown_toc_autofit = 1
 
 ### Text emphasis restriction to single-lines
 
-By default text emphasis works across multiple lines until a closing token is found. However, it's possible to restrict text emphasis to a single line (ie, for it to be applied a closing token must be found on the same line). To do so:
+By default text emphasis works across multiple lines until a closing token is found. However, it's possible to restrict text emphasis to a single line (i.e., for it to be applied a closing token must be found on the same line). To do so:
 
 ```vim
 let g:vim_markdown_emphasis_multiline = 0
@@ -147,7 +179,13 @@ set conceallevel=2
 To disable conceal regardless of `conceallevel` setting, add the following to your `.vimrc`:
 
 ```vim
-let g:vim_markdown_conceal = 0
+let g:vim_markdown_conceal = 0 
+```
+
+Disabling conceal for code fences requires an additional setting:
+
+```vim
+let g:vim_markdown_conceal_code_blocks = 0
 ```
 
 To disable math conceal with LaTeX math syntax enabled, add the following to your `.vimrc`:
@@ -176,7 +214,7 @@ Default is `['c++=cpp', 'viml=vim', 'bash=sh', 'ini=dosini']`.
 
 ### Follow named anchors
 
-This feature allows ge to follow named anchors in links of the form
+This feature allows the `ge` command to follow named anchors in links of the form
 `file#anchor` or just `#anchor`, where file may omit the `.md` extension as
 usual. Two variables control its operation:
 
@@ -245,6 +283,14 @@ JSON syntax highlight requires [vim-json](https://github.com/elzr/vim-json).
 let g:vim_markdown_json_frontmatter = 1
 ```
 
+#### Strikethrough
+
+Strikethrough uses two tildes. `~~Scratch this.~~`
+
+```vim
+let g:vim_markdown_strikethrough = 1
+```
+
 ### Adjust new list item indent
 
 You can adjust a new list indent. For example, you insert a single line like below:
@@ -293,6 +339,30 @@ If you would like to use a file extension other than `.md` you may do so using t
 let g:vim_markdown_auto_extension_ext = 'txt'
 ```
 
+### Do not automatically insert bulletpoints
+
+Automatically inserting bulletpoints can lead to problems when wrapping text
+(see issue #232 for details), so it can be disabled:
+
+```vim
+let g:vim_markdown_auto_insert_bullets = 0
+```
+
+In that case, you probably also want to set the new list item indent to 0 as
+well, or you will have to remove an indent each time you add a new list item:
+
+```vim
+let g:vim_markdown_new_list_item_indent = 0
+```
+
+### Change how to open new files
+
+By default when following a link the target file will be opened in your current buffer.  This behavior can change if you prefer using splits or tabs by using the `vim_markdown_edit_url_in` variable.  Possible values are `tab`, `vsplit`, `hsplit`, `current` opening in a new tab, vertical split, horizontal split, and current buffer respectively.  Defaults to current buffer if not set:
+
+```vim
+let g:vim_markdown_edit_url_in = 'tab'
+```
+
 ## Mappings
 
 The following work on normal and visual modes: