Add filetype mapping of ini to dosini

[etc/vim.git] / doc / vim-markdown.txt

diff --git a/doc/vim-markdown.txt b/doc/vim-markdown.txt
index c430eb80bb0bf799be178bbacc2fcf16ca6c3575..4b3d9299045bafd039286568f6c229b173c1fcba 100644 (file)
--- a/doc/vim-markdown.txt
+++ b/doc/vim-markdown.txt
@@ -10,9 +10,15 @@ Contents ~
   2. Change fold style                         |vim-markdown-change-fold-style|
   3. Set header folding level           |vim-markdown-set-header-folding-level|
   4. Disable Default Key Mappings   |vim-markdown-disable-default-key-mappings|
-  5. Syntax extensions                         |vim-markdown-syntax-extensions|
+  5. Enable TOC window auto-fit       |vim-markdown-enable-toc-window-auto-fit|
+  6. Text emphasis restriction to single-lines
+                       |vim-markdown-text-emphasis-restriction-to-single-lines|
+  7. Syntax Concealing                         |vim-markdown-syntax-concealing|
+  8. Syntax extensions                         |vim-markdown-syntax-extensions|
    1. LaTeX math                                      |vim-markdown-latex-math|
-   2. YAML frontmatter                          |vim-markdown-yaml-frontmatter|
+   2. YAML Front Matter                        |vim-markdown-yaml-front-matter|
+   3. TOML Front Matter                        |vim-markdown-toml-front-matter|
+   4. JSON Front Matter                        |vim-markdown-json-front-matter|
  4. Mappings                                            |vim-markdown-mappings|
  5. Commands                                            |vim-markdown-commands|
  6. Credits                                              |vim-markdown-credits|
@@ -109,6 +115,37 @@ Add the following line to your '.vimrc' to disable default key mappings:
 <
 You can also map them by yourself with '<Plug>' mappings.
 
+-------------------------------------------------------------------------------
+                                      *vim-markdown-enable-toc-window-auto-fit*
+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.
+>
+  let g:vim_markdown_toc_autofit = 1
+<
+-------------------------------------------------------------------------------
+                       *vim-markdown-text-emphasis-restriction-to-single-lines*
+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:
+>
+  let g:vim_markdown_emphasis_multiline = 0
+<
+-------------------------------------------------------------------------------
+                                               *vim-markdown-syntax-concealing*
+Syntax Concealing ~
+
+Concealing is set for some syntax.
+
+For example, conceal '[link text](link url)' as just 'link text'.
+
+To enable/disable conceal use Vim's standard conceal configuration.
+>
+  set conceallevel=2
+<
 -------------------------------------------------------------------------------
                                                *vim-markdown-syntax-extensions*
 Syntax extensions ~
@@ -125,13 +162,33 @@ Used as '$x^2$', '$$x^2$$', escapable as '\$x\$' and '\$\$x\$\$'.
   let g:vim_markdown_math = 1
 <
 -------------------------------------------------------------------------------
-                                                *vim-markdown-yaml-frontmatter*
-YAML frontmatter ~
+                                               *vim-markdown-yaml-front-matter*
+YAML Front Matter ~
 
-Highlight YAML frontmatter as used by Jekyll:
+Highlight YAML front matter as used by Jekyll or Hugo [7].
 >
   let g:vim_markdown_frontmatter = 1
 <
+-------------------------------------------------------------------------------
+                                               *vim-markdown-toml-front-matter*
+TOML Front Matter ~
+
+Highlight TOML front matter as used by Hugo [7].
+
+TOML syntax highlight requires vim-toml [8].
+>
+  let g:vim_markdown_toml_frontmatter = 1
+<
+-------------------------------------------------------------------------------
+                                               *vim-markdown-json-front-matter*
+JSON Front Matter ~
+
+Highlight JSON front matter as used by Hugo [7].
+
+JSON syntax highlight requires vim-json [9].
+>
+  let g:vim_markdown_json_frontmatter = 1
+<
 ===============================================================================
                                                         *vim-markdown-mappings*
 Mappings ~
@@ -191,6 +248,8 @@ To disable a map use:
                                                         *vim-markdown-commands*
 Commands ~
 
+The following requires ':filetype plugin on'.
+
                                                               *:HeaderDecrease*
 - ':HeaderDecrease':
 
@@ -215,9 +274,9 @@ Commands ~
   range.
 
                                                                  *:TableFormat*
-- ':TableFormat': Format the table under the cursor like this [7].
+- ':TableFormat': Format the table under the cursor like this [10].
 
-  Requires Tabular [8].
+  Requires Tabular [11].
 
   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
@@ -237,7 +296,7 @@ Commands ~
 - ':Toct': Same as ':Toc' but in a new tab.
 
                                                                         *:Tocv*
-- ':Tocv': Same as ':Toc' for symmetry with ':Toch' and 'Tocv'.
+- ':Tocv': Same as ':Toc' for symmetry with ':Toch' and ':Tocv'.
 
 ===============================================================================
                                                          *vim-markdown-credits*
@@ -246,7 +305,7 @@ Credits ~
 The main contributors of vim-markdown are:
 
 - **Ben Williams** (A.K.A. **plasticboy**). The original developer of vim-
-  markdown. Homepage [9].
+  markdown. Homepage [12].
 
 If you feel that your name should be on this list, please make a pull request
 listing your contributions.
@@ -287,8 +346,11 @@ References ~
 [4] http://packages.qa.debian.org/v/vim-addon-manager.html
 [5] https://github.com/plasticboy/vim-markdown/archive/master.tar.gz
 [6] https://github.com/klen/python-mode
-[7] http://www.cirosantilli.com/markdown-style-guide/#tables
-[8] https://github.com/godlygeek/tabular
-[9] http://plasticboy.com/
+[7] https://gohugo.io/content/front-matter/
+[8] https://github.com/cespare/vim-toml
+[9] https://github.com/elzr/vim-json
+[10] http://www.cirosantilli.com/markdown-style-guide/#tables
+[11] https://github.com/godlygeek/tabular
+[12] http://plasticboy.com/
 
 vim: ft=help