Change document for conceal Fix #258

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index fc3052aa287412b36d5fc58410f90e3481d61c46..014c54ea0326bb2f0302ff1179a98cc12e766faa 100644 (file)
--- a/README.md
+++ b/README.md
@@ -42,7 +42,7 @@ To install without Pathogen using the Debian [vim-addon-manager](http://packages
 git clone https://github.com/plasticboy/vim-markdown.git
 cd vim-markdown
 sudo make install
-vim-addon-manager install mkd
+vim-addon-manager install markdown
 ```
 
 If you are not using any package manager, download the [tarball](https://github.com/plasticboy/vim-markdown/archive/master.tar.gz) and do this:
@@ -59,7 +59,7 @@ tar --strip=1 -zxf vim-markdown-master.tar.gz
 Add the following line to your `.vimrc` to disable the folding configuration:
 
 ```vim
-let g:vim_markdown_folding_disabled=1
+let g:vim_markdown_folding_disabled = 1
 ```
 
 This option only controls Vim Markdown specific folding configuration.
@@ -70,16 +70,75 @@ To enable/disable folding use Vim's standard folding configuration.
 set [no]foldenable
 ```
 
+### Change fold style
+
+To fold in a style like [python-mode](https://github.com/klen/python-mode), add
+the following to your `.vimrc`:
+
+```vim
+let g:vim_markdown_folding_style_pythonic = 1
+```
+
+### Set header folding level
+
+Folding level is a number between 1 and 6. By default, if not specified, it is set to 1.
+
+```vim
+let g:vim_markdown_folding_level = 6
+```
+
+Tip: it can be changed on the fly with:
+
+```vim
+:let g:vim_markdown_folding_level = 1
+:edit
+```
+
 ### Disable Default Key Mappings
 
 Add the following line to your `.vimrc` to disable default key mappings:
 
 ```vim
-let g:vim_markdown_no_default_key_mappings=1
+let g:vim_markdown_no_default_key_mappings = 1
 ```
 
 You can also map them by yourself with `<Plug>` mappings.
 
+### Enable TOC window auto-fit
+
+Allow for the TOC window to auto-fit when it's possible for it to shrink.
+It never increases its default size (half screen), it only shrinks.
+
+```vim
+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:
+
+```vim
+let g:vim_markdown_emphasis_multiline = 0
+```
+
+### Syntax Concealing
+
+Concealing is set for some syntax.
+
+For example, conceal `[link text](link url)` as just `link text`.
+
+To enable conceal use Vim's standard conceal configuration.
+
+```vim
+set conceallevel=2
+```
+
+To disable conceal regardless of `conceallevel` setting, add the following to your '.vimrc':
+
+```vim
+let g:vim_markdown_conceal = 0
+```
+
 ### Syntax extensions
 
 The following options control which syntax extensions will be turned on. They are off by default.
@@ -89,22 +148,42 @@ The following options control which syntax extensions will be turned on. They ar
 Used as `$x^2$`, `$$x^2$$`, escapable as `\$x\$` and `\$\$x\$\$`.
 
 ```vim
-let g:vim_markdown_math=1
+let g:vim_markdown_math = 1
+```
+
+#### YAML Front Matter
+
+Highlight YAML front matter as used by Jekyll or [Hugo](https://gohugo.io/content/front-matter/).
+
+```vim
+let g:vim_markdown_frontmatter = 1
+```
+
+#### TOML Front Matter
+
+Highlight TOML front matter as used by [Hugo](https://gohugo.io/content/front-matter/).
+
+TOML syntax highlight requires [vim-toml](https://github.com/cespare/vim-toml).
+
+```vim
+let g:vim_markdown_toml_frontmatter = 1
 ```
 
-#### YAML frontmatter
+#### JSON Front Matter
+
+Highlight JSON front matter as used by [Hugo](https://gohugo.io/content/front-matter/).
 
-Highlight YAML frontmatter as used by Jekyll:
+JSON syntax highlight requires [vim-json](https://github.com/elzr/vim-json).
 
 ```vim
-let g:vim_markdown_frontmatter=1
+let g:vim_markdown_json_frontmatter = 1
 ```
 
 ## Mappings
 
 The following work on normal and visual modes:
 
--   `gx`: open the link under the cursor in the same browser as the standard `gx` command.
+-   `gx`: open the link under the cursor in the same browser as the standard `gx` command. `<Plug>Markdown_OpenUrlUnderCursor`
 
     The standard `gx` is extended by allowing you to put your cursor anywhere inside a link.
 
@@ -132,16 +211,18 @@ The following work on normal and visual modes:
 
 -   `]u`: go to parent header (Up). `<Plug>Markdown_MoveToParentHeader`
 
-This plugging follows the recommended Vim plugin mapping interface, so if you want to change the map `]u` to `asdf`, add to your `.vimrc`:
+This plugin follows the recommended Vim plugin mapping interface, so to change the map `]u` to `asdf`, add to your `.vimrc`:
 
     map asdf <Plug>Markdown_MoveToParentHeader
 
-To disable a map, use:
+To disable a map use:
 
     map <Plug> <Plug>Markdown_MoveToParentHeader
 
 ## Commands
 
+The following requires `:filetype plugin on`.
+
 -   `:HeaderDecrease`:
 
     Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc.
@@ -160,7 +241,7 @@ To disable a map, use:
 
     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-style-guide/#tables).
 
     Requires [Tabular](https://github.com/godlygeek/tabular).
 
@@ -175,7 +256,7 @@ To disable a map, use:
 
 -   `: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