ドキュメンテーション
Go製の静的サイトジェネレータHugo向けに、Bootstrapを使った簡素なドキュメンテーション用のテーマBootie Docsなる物を以前に作って、折りに触れてメンテナンスしています。 今回は特に大きな変更や機能追加はないのですが、互換性のない変更もありますので…
Bootie Docs はちょうど一年前ぐらいにドキュメンテーション用の静的サイトジェネレータがほしくて作った Hugo*1 の Theme (テンプレート)です。 当時の記事はこちら: Hugo で "bootie-docs" というドキュメンテーション用のテーマを作った #Hugo - weblog …
※2016/4/6 記事更新 こちらです。 Complete List | Hugo Themes にも Pull Request を送って、入れてもらっています。 Motivation 以前に Markdown によるドキュメント管理について、記事を書きました。 Markdown による中規模ドキュメンテーションシステム…
(追記) タイトルを "【緩募】Markdownによる中規模ドキュメンテーションシステム" から変えました。 (更に追記) 後日談 => Hugo で "bootie-docs" というドキュメンテーション用のテーマを作った #Hugo - weblog of key_amb 下のような疑問を持ったのがきっ…
Pod::Simple::HTML の POD に書いてある通りですが、Pod::Simple::HTML を継承したクラスを作って、生成する HTML をカスタマイズすることができます。 例えば、do_pod_link メソッドをオーバーライドすることで、L<...> で記述するリンクタグの挙動を変更で…
Module::Build を使うとプロジェクトのドキュメント生成をビルドのタスクの一部として、かんたんなコマンドで実行できます。 ./Build docs # blib/ 以下にドキュメント生成 ./Build html # blib/ 以下にHTML生成 Module::Build でプロジェクトの対象ファイル…