Merge pull request #275 from mpercy/master

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index b3681a53b698a06a84c177ca7107fdde6e20a171..9c6665ef2aeb88d74e125a360cb4662444b99adb 100644 (file)
--- a/README.md
+++ b/README.md
@@ -72,13 +72,15 @@ set [no]foldenable
 
 ### Change fold style
 
 
 ### Change fold style
 

-To fold in a style like [python-mode](https://github.com/klen/python-mode), add
-the following to your `.vimrc`:
+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
 ```
 
 
 ```vim
 let g:vim_markdown_folding_style_pythonic = 1
 ```
 

+Level 1 heading which is served as a document title is not folded.
+`g:vim_markdown_folding_level` setting is not active with this fold style.
+

 ### Set header folding level
 
 Folding level is a number between 1 and 6. By default, if not specified, it is set to 1.
 ### Set header folding level
 
 Folding level is a number between 1 and 6. By default, if not specified, it is set to 1.


@@ -127,12 +129,35 @@ Concealing is set for some syntax.
 
 For example, conceal `[link text](link url)` as just `link text`.
 
 
 For example, conceal `[link text](link url)` as just `link text`.
 

-To disable conceal, add the following to your '.vimrc':
+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
 ```
 
 
 ```vim
 let g:vim_markdown_conceal = 0
 ```
 

+### Fenced code block languages
+
+You can use filetype name as fenced code block languages for syntax highlighting.
+If you want to use different name from filetype, you can add it in your `.vimrc` like so:
+
+```vim
+let g:vim_markdown_fenced_languages = ['csharp=cs']
+```
+
+This will cause the following to be highlighted using the `cs` filetype syntax.
+
+    ```csharp
+    ...
+    ```
+
+Default is `['c++=cpp', 'viml=vim', 'bash=sh', 'ini=dosini']`.
+

 ### Syntax extensions
 
 The following options control which syntax extensions will be turned on. They are off by default.
 ### Syntax extensions
 
 The following options control which syntax extensions will be turned on. They are off by default.


@@ -173,6 +198,28 @@ 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
 ```
 

+### Adjust new list item indent
+
+You can adjust a new list indent. For example, you insert a single line like below:
+
+```
+* item1
+```
+
+Then if you type `o` to insert new line in vim and type `* item2`, the result will be:
+
+```
+* item1
+    * item2
+```
+
+vim-markdown automatically insert the indent. By default, the number of spaces of indent is 4. If you'd like to change the number as 2, just write:
+
+```vim
+let g:vim_markdown_new_list_item_indent = 2
+```
+
+

 ## Mappings
 
 The following work on normal and visual modes:
 ## Mappings
 
 The following work on normal and visual modes:


@@ -193,6 +240,10 @@ The following work on normal and visual modes:
 
     Known limitation: does not work for links that span multiple lines.
 
 
     Known limitation: does not work for links that span multiple lines.
 

+-   `ge`: open the link under the cursor in Vim for editing. Useful for relative markdown links. `<Plug>Markdown_EditUrlUnderCursor`
+
+    The rules for the cursor position are the same as the `gx` command.
+

 -   `]]`: go to next header. `<Plug>Markdown_MoveToNextHeader`
 
 -   `[[`: go to previous header. Contrast with `]c`. `<Plug>Markdown_MoveToPreviousHeader`
 -   `]]`: go to next header. `<Plug>Markdown_MoveToNextHeader`
 
 -   `[[`: go to previous header. Contrast with `]c`. `<Plug>Markdown_MoveToPreviousHeader`