Merge pull request #269 from yous/relaxed-fenced-code

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index c265d5bf7b4a93f622d81c666ddc33d914d080b5..90987f2ed164596d910f2fdf00778e02b043c7a0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -72,13 +72,15 @@ 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`:
+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
 ```
 
+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.
@@ -133,7 +135,7 @@ To enable conceal use Vim's standard conceal configuration.
 set conceallevel=2
 ```
 
-To disable conceal regardless of `conceallevel` setting, add the following to your '.vimrc':
+To disable conceal regardless of `conceallevel` setting, add the following to your `.vimrc`:
 
 ```vim
 let g:vim_markdown_conceal = 0
@@ -142,7 +144,7 @@ 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:
+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']
@@ -196,6 +198,28 @@ JSON syntax highlight requires [vim-json](https://github.com/elzr/vim-json).
 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: