Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Documentation for vim help file markup

Tags:

vim

markup

Is there a complete source of documentation on the markup format used in vim help files? :help write-local-help provides some info but does not, for example, document the markup used to indicate quoted sections.

update: I've also discovered this post on the vim-use mailing list which provides slightly more info than the afore-mentioned help entry.

like image 275
intuited Avatar asked Oct 02 '10 19:10

intuited


2 Answers

It seems everyone still sticks to reading another help file or reading the syntax file.

I did find the following two additional references:

  • Learn Vimscript The Hard Way: Documentation

  • :help help-writing

like image 108
JBert Avatar answered Oct 10 '22 03:10

JBert


:e $VIMRUNTIME/syntax/help.vim

This will indicate you how vim colours its own help files.

:help write-local-help

will also show you an example.

like image 43
Benoit Avatar answered Oct 10 '22 03:10

Benoit