reptee
a0cfb3fd31
Support for vimdoc, documentation format used by vim in its help pages. Relies heavily on definition lists and precise text alignment to generate tags.
1.3 KiB
Online vim documentation
While vim documentation can be accessed with :help, it may be beneficial to
link to the websites inside readme/markdown docs. Two most common websites are:
Also it is not uncommon to reference documentation as :h <topic>
Links to vimhelp.org
For introduction to writing help files see https://vimhelp.org/helphelp.txt.html#help-writing
Named link: vimhelp link
Links to neo.vimhelp.org
For introduction to writing help files see https://neo.vimhelp.org/helphelp.txt.html#help-writing
Named link: vimhelp link
Links to neovim.io
For introduction to writing help files see https://neovim.io/doc/user/helphelp.html#help-writing
Named link: neovim.io link
You can also reference whole files with topic omitted: https://neovim.io/doc/user/vim_diff.html
:h-style documentation
For introduction to writing help files see
:h help-writing
Long name for :help is also supported: :help help-writing
This is malformed: :help help-writing , but this is not: :help help-writing