]> git.ipfire.org Git - thirdparty/vim.git/commitdiff
runtime(doc): update Markdown syntax documentation and mention Pandoc
authorMao-Yining <mao.yining@outlook.com>
Sun, 14 Sep 2025 08:28:23 +0000 (04:28 -0400)
committerChristian Brabandt <cb@256bit.org>
Sun, 14 Sep 2025 08:28:23 +0000 (04:28 -0400)
fixes: #18286

Signed-off-by: Mao-Yining <mao.yining@outlook.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
runtime/doc/syntax.txt

index 39a64da63d82aed341714b686bfb7c257e3618bc..e6e4314b815f85db74d65b500c98b25efb02f44a 100644 (file)
@@ -1,4 +1,4 @@
-*syntax.txt*   For Vim version 9.1.  Last change: 2025 Sep 10
+*syntax.txt*   For Vim version 9.1.  Last change: 2025 Sep 14
 
 
                  VIM REFERENCE MANUAL    by Bram Moolenaar
@@ -2504,21 +2504,26 @@ $VIMRUNTIME/syntax/syntax.vim).
 MARKDOWN                       *ft-markdown-syntax* *g:markdown_minlines*
                 *g:markdown_fenced_languages* *g:markdown_syntax_conceal*
 
-If you have long regions there might be wrong highlighting.  At the cost of
+If you have long regions there may be incorrect highlighting.  At the cost of
 slowing down displaying, you can have the engine look further back to sync on
 the start of a region, for example 500 lines (default is 50): >
 
        :let g:markdown_minlines = 500
 
-If you want to enable fenced code block syntax highlighting in your markdown
-documents you can enable like this: >
+If you want to enable fenced code block syntax highlighting in your Markdown
+documents, set the following variable: >
 
        :let g:markdown_fenced_languages = ['html', 'python', 'bash=sh']
 
-To disable markdown syntax concealing add the following to your vimrc: >
+To disable Markdown syntax concealing, add the following to your vimrc: >
 
        :let g:markdown_syntax_conceal = 0
 
+For extended Markdown support with enhanced features such as citations,
+footnotes, mathematical formulas, academic writing elements and embedded code
+block highlighting, consider using the pandoc syntax plugin.  Set
+`g:filetype_md` to 'pandoc' and see |ft-pandoc-syntax| for configuration
+details.
 
 MATHEMATICA            *mma.vim* *ft-mma-syntax* *ft-mathematica-syntax*