如何编写类似gvim-help-doc的文本文件？

Question

gvim帮助doc包含"链接",我可以通过按ctrl +跳转到主题如何格式化一个可以像这样运行的文本

Answer 1

专用于该主题的帮助中有一节:"编写帮助文件"

见: help help-writing或:help helphelp.txt

摘录:

TAGS


To define a help tag, place the name between asterisks (*tag-name*). 

(...)

When referring to an existing help tag and to create a hot-link, place the
name between two bars (|) eg. |help-writing|.

要获得更多详细信息,请阅读前面提到的帮助文件.

Answer 2

Vim 的帮助文件存在于 $VIMRUNTIME/doc 中，因此如果您查看这些文件并设置

set syntax=off

这将使您对标记有所了解。基本上，您通过将链接包含在管道中来创建链接：

go to a link |here|

这将跳转到用星号括起来的链接文本的出现处，即*here*.

然后你只需要做

set filetype=help

对于您的文件，您可以使用自动命令来实现。