Change mkdRule match syntax to be more liberal

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index 0328b7f445ab1b4734a9bc8a8a78bb3a6088f233..0d03b34a09102309425665a58b8cd62a7a680a02 100644 (file)
--- a/README.md
+++ b/README.md
@@ -72,13 +72,21 @@ 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.
+
+To prevent foldtext from being set add the following to your `.vimrc`:
+
+```vim
+let g:vim_markdown_override_foldtext = 0
+```
+

 ### 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.


@@ -113,18 +121,59 @@ It never increases its default size (half screen), it only shrinks.
 let g:vim_markdown_toc_autofit = 1
 ```
 
 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`.
 ### Syntax Concealing
 
 Concealing is set for some syntax.
 
 For example, conceal `[link text](link url)` as just `link text`.

+Also, `_italic_` and `*italic*` will conceal to just _italic_.
+Similarly `__bold__`, `**bold**`, `___italic bold___`, and `***italic bold***`
+will conceal to just __bold__, **bold**, ___italic bold___, and ***italic bold*** respectively.
+
+To enable conceal use Vim's standard conceal configuration.
+
+```vim
+set conceallevel=2
+```

 
 

-To enable/disable conceal use Vim's standard conceal configuration.
+To disable conceal regardless of `conceallevel` setting, add the following to your `.vimrc`:

 
 ```vim
 
 ```vim

-set conceallevel = 2
+let g:vim_markdown_conceal = 0

 ```
 
 ```
 

+To disable math conceal with LaTeX math syntax enabled, add the following to your `.vimrc`:
+
+```vim
+let g:tex_conceal = ""
+let g:vim_markdown_math = 1
+```
+
+### 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.


@@ -137,14 +186,74 @@ Used as `$x^2$`, `$$x^2$$`, escapable as `\$x\$` and `\$\$x\$\$`.
 let g:vim_markdown_math = 1
 ```
 
 let g:vim_markdown_math = 1
 ```
 

-#### YAML frontmatter
+#### YAML Front Matter

 
 

-Highlight YAML frontmatter as used by Jekyll:
+Highlight YAML front matter as used by Jekyll or [Hugo](https://gohugo.io/content/front-matter/).

 
 ```vim
 let g:vim_markdown_frontmatter = 1
 ```
 
 
 ```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
+```
+
+#### JSON Front Matter
+
+Highlight JSON front matter as used by [Hugo](https://gohugo.io/content/front-matter/).
+
+JSON syntax highlight requires [vim-json](https://github.com/elzr/vim-json).
+
+```vim
+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
+```
+
+### Do not require .md extensions for Markdown links
+
+If you want to have a link like this `[link text](link-url)` and follow it for editing in vim using the `ge` command, but have it open the file "link-url.md" instead of the file "link-url", then use this option:
+
+```vim
+let g:vim_markdown_no_extensions_in_markdown = 1
+```
+This is super useful for GitLab and GitHub wiki repositories.
+
+Normal behaviour would be that vim-markup required you to do this `[link text](link-url.md)`, but this is not how the Gitlab and GitHub wiki repositories work. So this option adds some consistency between the two. 
+
+### Auto-write when following link
+
+If you follow a link like this `[link text](link-url)` using the `ge` shortcut, this option will automatically save any edits you made before moving you:
+
+```vim
+let g:vim_markdown_autowrite = 1
+```
+

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


@@ -165,6 +274,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`


@@ -222,7 +335,7 @@ The following requires `:filetype plugin on`.
 
 -   `:Toct`: Same as `:Toc` but in a new tab.
 
 
 -   `: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
 
 
 ## Credits