如何从Markdown注释或嵌入式注释生成Vim文档，或者有更好的方法添加文档？

14

这是一种在一两个问题。最近，我花了很多时间来深入学习vimscript，学习vim的内部知识，并开始编写vim插件。在此过程中，我一直在单独的markdown文件中保留大量注释，并在vimscript文件中添加许多内联“文档”注释。

我觉得我终于有了一些值得共享的代码，并且想要开始添加一些实际文档。我尚未编写任何自己的帮助文档文件，因此我仍在弄清楚该过程。

在没有任何经验或对该工作流程没有扎实的了解的情况下，我正在尝试完成两个任务：

关于想法的任何建议或建议（这是一个坏主意，因为...，更好的主意是...），或如何实现它们。

vimscript help-system

— Nfarrar
source

1

即使我不知道将markdown转换为vim的帮助文件类型的方法，但我确实知道如何编写它们的好介绍：learningvimscriptthehardway.stevelosh.com/chapters/54.html

— EvergreenTree

7

据我所知，目前对这两个问题都没有好的解决方案，但是很多人会对解决它们感兴趣。

Markdown是HTML的超集，因此我想说从Markdown转换为Vim帮助的正面方法不太可能成功。如果您会说Haskell，可以尝试为pandoc编写Vim帮助后端。即使它不是完美的，那也是一个非常好的解决方案。

另外，也有尝试将Vim帮助页面转换为有用的格式。有一些脚本可以生成官方帮助的HTML和PDF版本，并获得不同程度的成功。但是他们都依赖于风格上或多或少同质的帮助。即使是Vim帮助读者阅读Pandoc之类的东西，也将是一个值得的项目。

至于从Vim代码中提取文档，有一个用于Python，JavaScript和VimL本身的VimL解析器，名为vimlparser。很好，编写解析VimL源并转储特制注释的内容应该不难。能够将这些注释转换为POD之类的内容也非常有用。

— 液晶屏
source

4

我发现的最有前途的工具html2vimdoc.py可以在http://peterodding.com/code/vim/tools和github上找到。它可以将markdown和html转换为vim的帮助格式。广告功能包括：

— 霍奇克
source