<mazgi.github.io 移行済>簡易な技術ドキュメントをHugoで書くと便利だった - mazgi.log

この記事は以下に移行しました。 mazgi.log :: 簡易な技術ドキュメントをHugoで書くと便利だった サンプルコードのドキュメントをHugoで書いてサンプルコードと一緒に配ったら便利そうだったのでやってみた。 gohugo.io やりたいこと 仕事で他社さんにサンプルコードとドキュメントをセットでお渡ししたいのだけど社ではGitHub Enterpriseを使っているのでリポジトリを直接見ていただくことが難しいケースがある。 規模が大きいプロジェクトならSphinx使うと(やる気次第で)いくらでも綺麗なドキュメントが書けそうではあるけど、規模がそれほどじゃないうちはサクッとMarkdownで書いて、でもソースコードとドキュメントが整合性取れててほしいという気持ちになる。 (今はSphinxもMarkdownで書けるそうだ、最近知った) そもそも(私は)ドキュメント書きたくないので、

[mazgi]

移行しました=> https://mazgi.github.io/posts/2017.12/technical-docs-with-hugo/