MarkdownのメモやインラインコメントからVimドキュメントを生成する方法、またはドキュメントを追加するより良い方法はありますか？

これは、 2つの質問の1つです。最近、私はvimscriptの詳細を学び、vimの内部を学び、vimプラグインを書くための最初の一歩を踏み出しました。このプロセスの間、私は個々のマークダウンファイルに広範なメモを保存し、vimscriptファイルに多くのインラインの「ドキュメント」コメントを追加しました。

私はついに共有する価値のあるコードを手に入れたので、実際のドキュメントを追加したいと思っています。私はまだ自分のhelpdocファイルを作成していませんので、そのプロセスを理解しています。

このワークフローをまだ経験していないか、十分に理解していない場合、私が理解しようとしているタスクは2つあります。

1. vim / vimscript上のマークダウン「メモ」ファイルからhelpdocファイルを生成するため、vimからいつでもすばやく簡単に読み取り/参照できます。
2. vimscriptファイルからインラインドキュメントを解析し（shoccoがシェルスクリプトで機能する方法に似ています）、vimscriptに関連するヘルプドキュメントを生成します。

アイデアに関する提案やアドバイス（...、より良いアイデアは...）

私の知る限り、現在、どちらの問題に対しても良い解決策はありませんが、多くの人々がそれらの解決に興味を持っています。

MarkdownはHTMLのスーパーセットであるため、markdownからVimヘルプへの変換に対する正面からのアプローチは成功しそうにないと思います。Haskellを話すことができれば、pandocの Vimヘルプバックエンドを書くことができます。それが完璧ではない場合でも、それは非常に素晴らしいソリューションになります。

Vimのヘルプページを何らかの便利な形式に変換するという、逆の方法をいくつか試みました。公式ヘルプのHTMLおよびPDFバージョンを生成するいくつかのスクリプトがあり、さまざまな程度の成功を収めています。しかし、彼らは皆、助けが多かれ少なかれ同質であることに依存しています。pandocのようなものの Vimヘルプリーダーでさえ、価値のあるプロジェクトになります。

Vimコードからドキュメントを抽出する場合、Vimlparserという名前のPython、JavaScript、VimL自体にVimLのパーサーがあります。かなり良いです。VimLソースを解析し、特別に細工されたコメントをダンプするものを書くのは難しくありません。これらのコメントを、たとえばPODのようなものに変換できると、非常に便利です。

html2vimdoc.py

私が見つけた最も有望なツールはhtml2vimdoc.py、 http：//peterodding.com/code/vim/toolsとgithubにあります。markdownとhtmlをvimのヘルプ形式に変換できます。広告機能は次のとおりです。

• [BeautifulSoup] bsのおかげで複雑なHTMLを処理できます
• 見出しのVimヘルプファイルタグを自動的に生成します
• 見出しとタグから目次を生成します
• ネストされたリスト、リスト内の事前にフォーマットされたブロックなどのネストされたブロック構造をサポートします。
• リスト項目ごとの平均行数に基づいてリスト項目を圧縮および展開します

古い代替手段はhttps://github.com/mklabs/vim-markdown-helpfileです

/superuser//q/415470/generated-help-files-for-vimでも議論がありました