md2docs

README.mdなどマークダウン形式のファイルからドキュメントを自動生成するツールです。

現時点では実用性はなく、md2docsのコンセプトをお試ししてもらう程度にしか作り込めていません。将来的には、コマンド一つでREADME.mdからドキュメントページを生成できるようにしたいと考えています。

このツールを使えばREADME.md内の記述とドキュメントページの記述の誤記がなくなる他、わざわざhtmlファイルを用意する手間も省けます。テンプレートエンジンにEJSを利用しているので、ドキュメントのテンプレートファイルを自分好みにカスタマイズすることも容易です。

md2docs独自のルールに従ってマークダウンを記述する必要がありますので、当ドキュメントをお読みの上ご利用ください。また、まだベータ版としての公開なので機能不足や動作が不安定な場合があります。

ご意見・ご要望、共同開発を行ってくれる方は@kokushing、またはIssueへ書き込みをお願いします。