Merge pull request #248 from shirosaki/osx

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

diff --git a/doc/vim-markdown.txt b/doc/vim-markdown.txt
index 12ce7c8f78bfc654ef649791c415047476c989ea..6ec4480aa5deb5d88a7631a7a60dc8372fe57752 100644 (file)
--- a/doc/vim-markdown.txt
+++ b/doc/vim-markdown.txt
@@ -14,7 +14,9 @@ Contents ~
   6. Syntax Concealing                         |vim-markdown-syntax-concealing|
   7. Syntax extensions                         |vim-markdown-syntax-extensions|
    1. LaTeX math                                      |vim-markdown-latex-math|
   6. Syntax Concealing                         |vim-markdown-syntax-concealing|
   7. 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|
  4. Mappings                                            |vim-markdown-mappings|
  5. Commands                                            |vim-markdown-commands|
  6. Credits                                              |vim-markdown-credits|


@@ -130,7 +132,7 @@ For example, conceal '[link text](link url)' as just 'link text'.
 
 To enable/disable conceal use Vim's standard conceal configuration.
 >
 
 To enable/disable conceal use Vim's standard conceal configuration.
 >

-  set conceallevel = 2
+  set conceallevel=2

 <
 -------------------------------------------------------------------------------
                                                *vim-markdown-syntax-extensions*
 <
 -------------------------------------------------------------------------------
                                                *vim-markdown-syntax-extensions*


@@ -148,13 +150,33 @@ Used as '$x^2$', '$$x^2$$', escapable as '\$x\$' and '\$\$x\$\$'.
   let g:vim_markdown_math = 1
 <
 -------------------------------------------------------------------------------
   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
 <
 >
   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 ~
 ===============================================================================
                                                         *vim-markdown-mappings*
 Mappings ~


@@ -240,9 +262,9 @@ The following requires ':filetype plugin on'.
   range.
 
                                                                  *:TableFormat*
   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
 
   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


@@ -271,7 +293,7 @@ Credits ~
 The main contributors of vim-markdown are:
 
 - **Ben Williams** (A.K.A. **plasticboy**). The original developer of vim-
 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.
 
 If you feel that your name should be on this list, please make a pull request
 listing your contributions.


@@ -312,8 +334,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
 [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
 
 vim: ft=help