Mercurial > vim
comparison runtime/doc/syntax.txt @ 34807:7f709fa537df v9.1.0276
patch 9.1.0276: No pandoc syntax support
Commit: https://github.com/vim/vim/commit/7005b7ee7f282b24378c2a844366cb8616cad5d7
Author: Wu, Zhenyu <wuzhenyu@ustc.edu>
Date: Mon Apr 8 20:53:19 2024 +0200
patch 9.1.0276: No pandoc syntax support
Problem: No pandoc syntax support
Solution: Add pandoc syntax and compiler plugins
(Wu, Zhenyu, Konfekt)
closes: #14389
Co-authored-by: Konfekt <Konfekt@users.noreply.github.com>
Signed-off-by: Wu, Zhenyu <wuzhenyu@ustc.edu>
Signed-off-by: Christian Brabandt <cb@256bit.org>
| author | Christian Brabandt <cb@256bit.org> |
|---|---|
| date | Mon, 08 Apr 2024 22:00:03 +0200 |
| parents | caf019e67e93 |
| children | a6e19365c34d |
comparison
equal
deleted
inserted
replaced
| 34806:33cac3f2dec5 | 34807:7f709fa537df |
|---|---|
| 1 *syntax.txt* For Vim version 9.1. Last change: 2024 Mar 10 | 1 *syntax.txt* For Vim version 9.1. Last change: 2024 Apr 08 |
| 2 | 2 |
| 3 | 3 |
| 4 VIM REFERENCE MANUAL by Bram Moolenaar | 4 VIM REFERENCE MANUAL by Bram Moolenaar |
| 5 | 5 |
| 6 | 6 |
| 2465 :let ocaml_noend_error = 1 | 2465 :let ocaml_noend_error = 1 |
| 2466 | 2466 |
| 2467 prevents highlighting of "end" as error, which is useful when sources | 2467 prevents highlighting of "end" as error, which is useful when sources |
| 2468 contain very long structures that Vim does not synchronize anymore. | 2468 contain very long structures that Vim does not synchronize anymore. |
| 2469 | 2469 |
| 2470 PANDOC *ft-pandoc-syntax* | |
| 2471 | |
| 2472 By default, markdown files will be detected as filetype "markdown". | |
| 2473 Alternatively, you may want them to be detected as filetype "pandoc" instead. | |
| 2474 To do so, set the following: > | |
| 2475 | |
| 2476 :let g:markdown_md = 'pandoc' | |
| 2477 | |
| 2478 The pandoc syntax plugin uses |conceal| for pretty highlighting. Default is 1 > | |
| 2479 | |
| 2480 :let g:pandoc#syntax#conceal#use = 1 | |
| 2481 | |
| 2482 To specify elements that should not be concealed, set the following variable: > | |
| 2483 | |
| 2484 :let g:pandoc#syntax#conceal#blacklist = [] | |
| 2485 | |
| 2486 This is a list of the rules wich can be used here: | |
| 2487 | |
| 2488 - titleblock | |
| 2489 - image | |
| 2490 - block | |
| 2491 - subscript | |
| 2492 - superscript | |
| 2493 - strikeout | |
| 2494 - atx | |
| 2495 - codeblock_start | |
| 2496 - codeblock_delim | |
| 2497 - footnote | |
| 2498 - definition | |
| 2499 - list | |
| 2500 - newline | |
| 2501 - dashes | |
| 2502 - ellipses | |
| 2503 - quotes | |
| 2504 - inlinecode | |
| 2505 - inlinemath | |
| 2506 | |
| 2507 You can customize the way concealing works. For example, if you prefer to mark | |
| 2508 footnotes with the `*` symbol: > | |
| 2509 | |
| 2510 :let g:pandoc#syntax#conceal#cchar_overrides = {"footnote" : "*"} | |
| 2511 | |
| 2512 To conceal the urls in links, use: > | |
| 2513 | |
| 2514 :let g:pandoc#syntax#conceal#urls = 1 | |
| 2515 | |
| 2516 Prevent highlighting specific codeblock types so that they remain Normal. | |
| 2517 Codeblock types include "definition" for codeblocks inside definition blocks | |
| 2518 and "delimited" for delimited codeblocks. Default = [] > | |
| 2519 | |
| 2520 :let g:pandoc#syntax#codeblocks#ignore = ['definition'] | |
| 2521 | |
| 2522 Use embedded highlighting for delimited codeblocks where a language is | |
| 2523 specified. Default = 1 > | |
| 2524 | |
| 2525 :let g:pandoc#syntax#codeblocks#embeds#use = 1 | |
| 2526 | |
| 2527 For specify what languages and using what syntax files to highlight embeds. This is a | |
| 2528 list of language names. When the language pandoc and vim use don't match, you | |
| 2529 can use the "PANDOC=VIM" syntax. For example: > | |
| 2530 | |
| 2531 :let g:pandoc#syntax#codeblocks#embeds#langs = ["ruby", "bash=sh"] | |
| 2532 | |
| 2533 To use italics and strong in emphases. Default = 1 > | |
| 2534 | |
| 2535 :let *g:pandoc#syntax#style#emphases = 1 | |
| 2536 | |
| 2537 "0" will add "block" to g:pandoc#syntax#conceal#blacklist, because otherwise | |
| 2538 you couldn't tell where the styles are applied. | |
| 2539 | |
| 2540 To add underline subscript, superscript and strikeout text styles. Default = 1 > | |
| 2541 | |
| 2542 :let g:pandoc#syntax#style#underline_special = 1 | |
| 2543 | |
| 2544 Detect and highlight definition lists. Disabling this can improve performance. | |
| 2545 Default = 1 (i.e., enabled by default) > | |
| 2546 | |
| 2547 :let g:pandoc#syntax#style#use_definition_lists = 1 | |
| 2548 | |
| 2549 The pandoc syntax script also comes with the following commands: > | |
| 2550 | |
| 2551 :PandocHighlight LANG | |
| 2552 | |
| 2553 Enables embedded highlighting for language LANG in codeblocks. Uses the | |
| 2554 syntax for items in g:pandoc#syntax#codeblocks#embeds#langs. > | |
| 2555 | |
| 2556 :PandocUnhighlight LANG | |
| 2557 | |
| 2558 Disables embedded highlighting for language LANG in codeblocks. | |
| 2470 | 2559 |
| 2471 PAPP *papp.vim* *ft-papp-syntax* | 2560 PAPP *papp.vim* *ft-papp-syntax* |
| 2472 | 2561 |
| 2473 The PApp syntax file handles .papp files and, to a lesser extent, .pxml | 2562 The PApp syntax file handles .papp files and, to a lesser extent, .pxml |
| 2474 and .pxsl files which are all a mixture of perl/xml/html/other using xml | 2563 and .pxsl files which are all a mixture of perl/xml/html/other using xml |