Hugoのイケてるドキュメンテーション用Theme "Learn"と"DocDock"
はじめに
3年前(後述)に探したときは良いものが見つけられなかったのですが、時代は進んで便利なThemeが登場しているようです。
ドキュメントをHugoで作ると、Markdownでソースを管理できるのが良いですね。
この記事では主に"Learn"と"DocDock"という2つのThemeを紹介します。
Learn
Learn Theme for Hugo :: Documentation for Hugo Learn Theme
上がデモサイトにもなっています。
簡単に特長を紹介しておきます:
他にもいくつか機能がありますので、上のサイトを確認ください。
DocDock
こちらは、Learnのフォークですが、作者はLearnにもコントリビュートしているようです。
LearnのREADMEにcreditが載せられています。
Learnと違って多言語対応はしていませんが、独自機能としてreveal.jsによるスライド生成機能があるようです。
Bootie Docsとの比較
私自身も、3年前にbootie-docsというドキュメンテーション用のThemeを作って、ほそぼそとメンテを続けています。
正直に言って、bootie-docsよりもLearnやDocDockの方が機能が豊富で良さそうです^^;
特に、ドキュメントが増えてくると、メニューを一階層しか持てないBootie Docsでは苦しくなってくるかもしれません。
その他のTheme
ドキュメンテーション用のThemeは下のページを見ると他にもあります。
https://themes.gohugo.io/tags/documentation
ざっと見たところ、APIドキュメントを書くときはDocuAPIもよさそうだなと思いました。
先に挙げた2つのThemeは一般的な用途で使いやすそうです。
結びに
次にソフトウェアドキュメントを書くときには、LearnかDocDockのいずれかを試してみたいと思います。
3年前について
- Markdown による中規模ドキュメンテーションシステムについて調べた。 - weblog of key_amb
- Hugo で "bootie-docs" というドキュメンテーション用のテーマを作った #Hugo - weblog of key_amb
