为vim生成帮助文件

8

目前，我直接将文档作为vim帮助文件编写。有时我需要生成其他格式（例如PDF）。我的工作流程是复制帮助文件的内容，并将其转换为我需要的内容。这是一件非常繁琐的工作，因为我主要不得不添加其他标记。

我喜欢Markdown的方法，可以（例如使用Pandoc）将其转换为多种输出格式。不幸的是没有vim帮助文件。我正在寻找一种采用标准输入格式（例如XML，Markdown，重构的文本，纯文本等）并输出 vim帮助文件的转换器。还是有其他方法可以自动生成vim帮助文件而无需自己编写此类转换器？

vim

— 马可
source

您可能会在几个小时内将XSLT样式表合并在一起。

— 伊格纳西奥·巴斯克斯

11

对不起，很老的线程复活了。我是lornix先前mkd2vimdoc建议的第一个链接背后的脚本的作者。我最近重新编写了html2vimdoc。它仍然支持Markdown作为输入格式。它将Markdown转换为HTML，然后将该HTML转换为Vim帮助文件。重写期间的重点是支持更广泛的输入文档。mkd2vimdoc

本人和其他一些插件作者正在使用该新脚本，因此绝对可以将其用作一般用途。如果您想再尝试一次，我很想知道它现在是否适合您要使用它的文档。如果仍然无法使用，请随时在GitHub上创建一个问题。

— olo
source

3

欢迎来到超级用户！在这里可以回答旧问题，有些人可能仍在寻找答案，可以改善旧问题。

— gronostaj 2013年

4

我找到了这个脚本，作者创建了将markdown转换为vim文档的脚本。听起来非常接近您要寻找的东西。

尽管此 vim.org脚本（github repo）将markdown转换为几乎所有的vimdoc。（叹气）这么近...也许稍作修改？

— Lornix
source

第一个脚本不可用于一般用途。它可能适用于作者的标记样式，但没有正确转换我的（有效）标记文件中的一个。第二个选择是pandoc，这是我非常喜欢的功能非常强大的转换器。不幸的是，它不支持vimhelp。我在邮件列表中要求添加对它的支持，但回答是vimhelp不是通用输出格式，而是专用于vim文档的专用格式，与其他受支持格式相反。无论如何，非常感谢您的提示。

— Marco Marco 2012年

我很好奇创建从markdown到vimdoc的转换器可能需要什么，因为大多数vimdoc是格式化和特殊标记字符，而魔术是通过helptags命令和vim帮助查看器本身完成的。当然，我可以（再次！）将我的脚放进嘴里……也许这取决于您最初减价的复杂性。

— lornix 2012年

邮件列表上建议的一个聪明的解决方法是创建vimhelp，它也是有效的markdown。缺点是Markdown的vim语法有点混乱，并且vimhelp文件不遵守格式约定。但除此之外，它是可用的。

— Marco