diff --git a/runtime/doc/helphelp.txt b/runtime/doc/helphelp.txt index ef5b16ff42..bb7358a380 100644 --- a/runtime/doc/helphelp.txt +++ b/runtime/doc/helphelp.txt @@ -377,7 +377,13 @@ also implicitly stops the block of ex-commands before it. E.g. > echo "Example" endfunction < - +It's possible to add Vim syntax highlighting support to code examples. This +can be done by adding "vim" after the greater than (>) character (">vim"). +E.g: >vim + function Example_Func() + echo "Example" + endfunction +< The following are highlighted differently in a Vim help file: - a special key name expressed either in <> notation as in , or as a Ctrl character as in CTRL-X diff --git a/runtime/syntax/help.vim b/runtime/syntax/help.vim index c8ad8bfe4a..3806269e6b 100644 --- a/runtime/syntax/help.vim +++ b/runtime/syntax/help.vim @@ -1,7 +1,7 @@ " Vim syntax file " Language: Vim help file " Maintainer: The Vim Project -" Last Change: 2024 Oct 16 +" Last Change: 2024 Dec 15 " Former Maintainer: Bram Moolenaar " Quit when a (custom) syntax file was already loaded @@ -15,11 +15,24 @@ set cpo&vim syn match helpHeadline "^[A-Z.][-A-Z0-9 .,()_']*?\=\ze\(\s\+\*\|$\)" syn match helpSectionDelim "^===.*===$" syn match helpSectionDelim "^---.*--$" + +unlet! b:current_syntax +" sil! to prevent E403 +silent! syntax include @VimScript syntax/vim.vim + " Nvim: support language annotation in codeblocks if has("conceal") syn region helpExample matchgroup=helpIgnore start=" >[a-z0-9]*$" start="^>[a-z0-9]*$" end="^[^ \t]"me=e-1 end="^<" concealends + syn region helpExampleVimScript matchgroup=helpIgnore + \ start=/^>vim$/ start=/ >vim$/ + \ end=/^[^ \t]/me=e-1 end=/^[a-z0-9]*$" start="^>[a-z0-9]*$" end="^[^ \t]"me=e-1 end="^<" + syn region helpExampleVimScript matchgroup=helpIgnore + \ start=/^>vim$/ start=/ >vim$/ + \ end=/^[^ \t]/me=e-1 end=/^