GFM を使用するために Rake 経由で Yard から Kramdown にオプションを渡す方法
概要
私は、構文強調表示を利用するために Github Flavored Markdown (GFM) で書かれたいくつかのドキュメントを使用して作成した gem を持っています。
残念ながら、Github はコード ブロック フェンシング (3 つのバッククォート) に独自の構文を使用することを決定したため、Yardoc にそれを正しく解析させるために、GFM をサポートするパーサーとして Kramdown を選択しました。
さらに、コードを Rubygems にプッシュすると、Rake タスクを実行することによってドキュメントが生成されます (私が理解している限り)。したがって、Rake 経由で Yard に Kramdown GFM パーサーを使用するように指示する方法を見つける必要があります。
Kramdown は -i スイッチを介してパーサーを選択します。
$ bin/kramdown --help
Command line options:
-i, --input ARG
Specify the input format: kramdown (default), html, GFM or markdown
しかし、ヤードバイナリまたはレイクを介してヤードにそれを渡す方法がわかりません。 Yardoc プラグインを作成すればこれが可能になると思いますが、私はそれをやったことがないので、うまくいくかどうかわかりません。また、その時点で事態が手に負えなくなりそうな気もします。
私が本当に望んでいるのは、このためのマークダウン標準ですが、それは質問というよりも満たされない願望です…スタック オーバーフローがこれらの点でそれほど役立つかどうかはわかりません。
解決策
私は最近この問題に遭遇しましたが、明確なガイダンスをどこにも見つけるのに苦労していました。そのため、Yard の問題とソースを調べた結果、このアプローチを思いつきました。これには非常に満足しています。このスレッドに出会った他の人にとって役立つかもしれないことを願っています。