Docsy

https://www.docsy.dev/

Googleが2019年に公開したHugoのテーマ。

事例がここに載っている。
kubeflow, Knative, Apache Airflowなどで使われている。

20ページ以上のドキュメントサイトを作るときに向いている、と謳っている。
多言語対応しており、プロダクトのバージョニングも考慮されている。

Documentation

https://www.docsy.dev/docs/

Getting Started

https://www.docsy.dev/docs/getting-started/

Hugoの拡張版が必要。
これはSCSSを使っているためのようだ。

参考:

• Error building site: POSTCSS: failed to transform "scss/main.css" · Issue #235 · google/docsy

デモサイトのソースをcloneして使う

ふつうのHugo Themeなら、 hugo new site してconfig.tomlでthemeを指定すれば大体それっぽく動くのだけど、Docsyはやや作りが複雑なようなので、Exampleサイトのソースを再利用した方が早そう。

git clone https://github.com/google/docsy-example.git mydocs
cd mydocs
git submodule update --init --recursive

Configuration

サイト内検索

Navigation and Search

2020-05-31現在、以下の3つの検索方法から1つを選べる:

• Googleカスタム検索エンジン https://cse.google.com/cse/all
• Algolia DocSearch https://docsearch.algolia.com/
• Lunr.jsによるローカル検索