neovim

Neovim text editor
git clone https://git.dasho.dev/neovim.git
Log | Files | Refs | README

commit 7082367b3a52a2287a57fc2656eee0510e50fe36
parent 60b866049ce1af01af204a9804fa062d5673e6d2
Author: brianhuster <phambinhanctb2004@gmail.com>
Date:   Sat, 31 May 2025 19:58:16 +0700

vim-patch:b9ea0a8: runtime(doc): tweak documentation style in helphelp.txt

closes: vim/vim#16302

https://github.com/vim/vim/commit/b9ea0a89fadb53812860b8c2c1ca27e1d51a33da

Co-authored-by: h-east <h.east.727@gmail.com>

I removed some parts that are not applicable to Nvim, like HelpTOC

Diffstat:
Mruntime/doc/helphelp.txt | 25++-----------------------
1 file changed, 2 insertions(+), 23 deletions(-)

diff --git a/runtime/doc/helphelp.txt b/runtime/doc/helphelp.txt @@ -377,33 +377,12 @@ also implicitly stops the block of ex-commands before it. E.g. > echo "Example" endfunction < - -To add annotation in the block, place the annotation (ex: "lua") after a -greater than (>) character. E.g: >lua - print("hello") -< -Note: uses lua syntax highlighting, if "lua" key is in -|g:help_example_languages|. - -It's possible to add Vim syntax highlighting support to code examples. -E.g: >vim +To enable syntax highlighting for a block of code, place a language name +annotation (e.g. "vim") after a greater than (>) character. E.g. >vim function Example_Func() echo "Example" endfunction < - *g:help_example_languages* -If you want to change the syntax highlighting in the block, you can -change it like this: > - :let g:help_example_languages = #{ vim: 'vim', sh: 'bash' } -The key represents the annotation marker name, and the value is the 'syntax' -name. By default, help files support only Vim script highlighting. -Note: When setting "g:help_example_languages", if you do not include "vim" -key, the Vim syntax highlighting will not be enabled. If you set it to an -empty value, syntax highlighting for embedded languages will be disabled. - -Further note: including additional syntax languages into help files may not -always work perfectly, if the included 'syntax' script does not account for -such an import. *help-notation* The following are highlighted differently in a Vim help file: - a special key name expressed either in <> notation as in <PageDown>, or