ITエンジニア/デザイナ向けにオープンソースを毎日紹介

最近ドキュメントはMarkdownフォーマットで統一するようにしています。しかしドキュメントが大きくなるとメンテナンスコストが増大してしまいます。そこで分割するのですが、Markdownの基本機能だけではドキュメントを分割した場合にうまく対応できません。

そこで使ってみたいのがGugoDocです。複数のMarkdownファイルを結合、表示してくれるHTMLドキュメントジェネレータです。

使い方は簡単で、入力ファイルが入っているフォルダ、出力先のフォルダを指定するだけです。

$ ./gugodoc tmp tmp2
Build Site tmp to directory tmp2
Warning : output dir not found -> tmp2 created 
Info: Create raw directory in _source_dir
Convert -> tmp/index.md
Warning no YAML header found -> use filename instead
Convert -> tmp/Index.md
Warning no YAML header found -> use filename instead
Warning: footer.md file not found in tmp ->created empty one
Convert -> tmp/footer.md
Warning no YAML header found -> use filename instead
Done with grace and subtility

そうするとこんな感じにHTMLファイルが生成されます。
そうするとこんな感じにHTMLファイルが生成されます。

日本語でも特に問題ありません。
日本語でも特に問題ありません。

各ファイルの並びはアルファベット順となっています。また

%%TOC%%
とHTMLテンプレートに書いておくと目次が生成されます。タイトルなどはYAMLファイルで定義ができるようになっています。

GugoDocは基本はMarkdownなのでこれまでの資産を活かした運用ができるはずです。プロジェクト内容を記述していてMarkdownが肥大化して困る…という方は使ってみると良いでしょう。

GugoDocはWindows/Mac OSX/Linux用のオープンソース・ソフトウェア(BSD License)です。

Gugodoc 2014

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2