Syntax: Fix strikethrough

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index bb26e05fa2b5612cf07d33d8958d845fe6dc4d4e..25b708786e66b8b917c820254b7df2417af6da4e 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)
 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)
 1. [Options](#options)
 1. [Mappings](#mappings)
 1. [Commands](#commands)


@@ -52,6 +53,37 @@ cd ~/.vim
 tar --strip=1 -zxf vim-markdown-master.tar.gz
 ```
 
 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
 ## Options
 
 ### Disable Folding


@@ -245,6 +277,14 @@ JSON syntax highlight requires [vim-json](https://github.com/elzr/vim-json).
 let g:vim_markdown_json_frontmatter = 1
 ```
 
 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:
 ### Adjust new list item indent
 
 You can adjust a new list indent. For example, you insert a single line like below: