Change mkdRule match syntax to be more liberal

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index 9583a4385b1e4ada0e140c26f6e3e3d239f303d6..0d03b34a09102309425665a58b8cd62a7a680a02 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,72 +1,179 @@
-# Markdown Vim Mode
+# Vim Markdown

 
 [![Build Status](https://travis-ci.org/plasticboy/vim-markdown.svg)](https://travis-ci.org/plasticboy/vim-markdown)
 
 Syntax highlighting, matching rules and mappings for [the original Markdown](http://daringfireball.net/projects/markdown/) and extensions.
 
 
 [![Build Status](https://travis-ci.org/plasticboy/vim-markdown.svg)](https://travis-ci.org/plasticboy/vim-markdown)
 
 Syntax highlighting, matching rules and mappings for [the original Markdown](http://daringfireball.net/projects/markdown/) and extensions.
 

+1. [Installation](#installation)
+1. [Options](#options)
+1. [Mappings](#mappings)
+1. [Commands](#commands)
+1. [Credits](#credits)
+1. [License](#license)
+

 ## Installation
 
 If you use [Vundle](https://github.com/gmarik/vundle), add the following line to your `~/.vimrc`:
 
 ## Installation
 
 If you use [Vundle](https://github.com/gmarik/vundle), add the following line to your `~/.vimrc`:
 

-    Plugin 'godlygeek/tabular'
-    Plugin 'plasticboy/vim-markdown'
+```vim
+Plugin 'godlygeek/tabular'
+Plugin 'plasticboy/vim-markdown'
+```

 
 

-The `tabular` plugin come *before* `vim-markdown`.
+The `tabular` plugin must come *before* `vim-markdown`.

 
 Then run inside Vim:
 
 
 Then run inside Vim:
 

-    :so ~/.vimrc
-    :PluginInstall
+```vim
+:so ~/.vimrc
+:PluginInstall
+```

 
 If you use [Pathogen](https://github.com/tpope/vim-pathogen), do this:
 
 
 If you use [Pathogen](https://github.com/tpope/vim-pathogen), do this:
 

-    $ cd ~/.vim/bundle
-    $ git clone https://github.com/plasticboy/vim-markdown.git
+```sh
+cd ~/.vim/bundle
+git clone https://github.com/plasticboy/vim-markdown.git
+```

 
 To install without Pathogen using the Debian [vim-addon-manager](http://packages.qa.debian.org/v/vim-addon-manager.html), do this:
 
 
 To install without Pathogen using the Debian [vim-addon-manager](http://packages.qa.debian.org/v/vim-addon-manager.html), do this:
 

-    $ git clone https://github.com/plasticboy/vim-markdown.git
-    $ cd vim-markdown
-    $ sudo make install
-    $ vim-addon-manager install mkd
+```sh
+git clone https://github.com/plasticboy/vim-markdown.git
+cd vim-markdown
+sudo make install
+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:
 
 
 If you are not using any package manager, download the [tarball](https://github.com/plasticboy/vim-markdown/archive/master.tar.gz) and do this:
 

-    $ cd ~/.vim
-    $ tar --strip=1 -zxf vim-markdown-master.tar.gz
+```sh
+cd ~/.vim
+tar --strip=1 -zxf vim-markdown-master.tar.gz
+```

 
 ## Options
 
 ### Disable Folding
 
 
 ## Options
 
 ### Disable Folding
 

-Add the following line to your `.vimrc` to disable folding configuration.
+Add the following line to your `.vimrc` to disable the folding configuration:

 
 ```vim
 
 ```vim

-let g:vim_markdown_folding_disabled=1
+let g:vim_markdown_folding_disabled = 1

 ```
 
 ```
 

-This option only controls vim_markdown's folding configuration. To enable/disable folding use Vim's folding configuration.
+This option only controls Vim Markdown specific folding configuration.
+
+To enable/disable folding use Vim's standard folding configuration.

 
 ```vim
 set [no]foldenable
 ```
 
 
 ```vim
 set [no]foldenable
 ```
 

-### Set Initial Foldlevel
+### 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
+```
+
+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.

 
 

-Add the following line to your `.vimrc` to set the initial foldlevel. This option defaults to 0 (i.e. all folds are closed) and is ignored if folding is disabled.
+To prevent foldtext from being set add the following to your `.vimrc`:

 
 ```vim
 
 ```vim

-let g:vim_markdown_initial_foldlevel=1
+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.
+
+```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
 
 ```
 
 ### Disable Default Key Mappings
 

-Add the following line to your `.vimrc` to disable default key mappings. You can map them by yourself with `<Plug>` mappings.
+Add the following line to your `.vimrc` to disable default key mappings:
+
+```vim
+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`.
+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 disable conceal regardless of `conceallevel` setting, add the following to your `.vimrc`:
+
+```vim
+let g:vim_markdown_conceal = 0
+```
+
+To disable math conceal with LaTeX math syntax enabled, add the following to your `.vimrc`:

 
 ```vim
 
 ```vim

-let g:vim_markdown_no_default_key_mappings=1
+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.


@@ -76,31 +183,126 @@ 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
 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
+```
+
+#### 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

 ```
 
 ```
 

-#### YAML frontmatter
+Then if you type `o` to insert new line in vim and type `* item2`, the result will be:

 
 

-Highlight YAML frontmatter as used by Jekyll:
+```
+* 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
 
 ```vim

-let g:vim_markdown_frontmatter=1
+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:
 

-- `]]`: go to next header. `<Plug>(Markdown_MoveToNextHeader)`
-- `[[`: go to previous header. Contrast with `]c`. `<Plug>(Markdown_MoveToPreviousHeader)`
-- `][`: go to next sibling header if any. `<Plug>(Markdown_MoveToNextSiblingHeader)`
-- `[]`: go to previous sibling header if any. `<Plug>(Markdown_MoveToPreviousSiblingHeader)`
-- `]c`: go to Current header. `<Plug>(Markdown_MoveToCurHeader)`
-- `]u`: go to parent header (Up). `<Plug>(Markdown_MoveToParentHeader)`
+-   `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.
+
+    For example, all the following cursor positions will work:
+
+        [Example](http://example.com)
+        ^  ^    ^^   ^       ^
+        1  2    34   5       6
+
+        <http://example.com>
+        ^  ^               ^
+        1  2               3
+
+    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 sibling header if any. `<Plug>Markdown_MoveToNextSiblingHeader`
+
+-   `[]`: go to previous sibling header if any. `<Plug>Markdown_MoveToPreviousSiblingHeader`
+
+-   `]c`: go to Current header. `<Plug>Markdown_MoveToCurHeader`
+
+-   `]u`: go to parent header (Up). `<Plug>Markdown_MoveToParentHeader`
+
+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:
+
+    map <Plug> <Plug>Markdown_MoveToParentHeader

 
 ## Commands
 
 
 ## Commands
 

-- `:HeaderDecrease`:
+The following requires `:filetype plugin on`.
+
+-   `:HeaderDecrease`:

 
     Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc.
 
 
     Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc.
 


@@ -110,30 +312,30 @@ The following work on normal and visual modes:
 
     For simplicity of implementation, Setex headers are converted to Atx.
 
 
     For simplicity of implementation, Setex headers are converted to Atx.
 

-- `:HeaderIncrease`: Analogous to `:HeaderDecrease`, but increase levels instead.
+-   `:HeaderIncrease`: Analogous to `:HeaderDecrease`, but increase levels instead.

 
 

-- `:SetexToAtx`:
+-   `:SetexToAtx`:

 
     Convert all Setex style headers in buffer to Atx.
 
     If a range is given, e.g. hit `:` from visual mode, only operate on the range.
 
 
     Convert all Setex style headers in buffer to Atx.
 
     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).
 
     The input table *must* already have a separator line as the second line of the table.
     That line only needs to contain the correct pipes `|`, nothing else is required.
 
 
     Requires [Tabular](https://github.com/godlygeek/tabular).
 
     The input table *must* already have a separator line as the second line of the table.
     That line only needs to contain the correct pipes `|`, nothing else is required.
 

-- `:Toc`: create a quickfix vertical window navigable table of contents with the headers.
+-   `:Toc`: create a quickfix vertical window navigable table of contents with the headers.

 
     Hit `<Enter>` on a line to jump to the corresponding line of the markdown file.
 
 
     Hit `<Enter>` on a line to jump to the corresponding line of the markdown file.
 

-- `:Toch`: Same as `:Toc` but in an horizontal window.
+-   `:Toch`: Same as `:Toc` but in an horizontal window.

 
 

-- `: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