Repolode
alex-shpak

alex-shpak/hugo-book

Hugo向けの、シンプルでモバイル対応の、書籍のようなデザインのドキュメントテーマ。

スター
4,097
フォーク
1,311
未解決の Issue
8
最終コミット
昨日

これは何?

Hugo Bookは、Markdownコンテンツをすっきりとした書籍風レイアウトのドキュメントサイトに変換する、Hugo向けのテーマです。サイドバーのツリーナビゲーション、検索しやすい構造、ライトモードとダークモードを備え、初期設定なしですぐに使えるよう設計されています。

ドキュメントでよく使われる要素の組み込みショートコード、多言語サイトへの対応、シンプルなブログページやタクソノミーページを備えています。主要機能はJavaScriptなしで動作し、ユーザー定義のレイアウトを妨げないこと、可能な限りJSよりCSSを優先することを目指しています。

すぐにセットアップできるスターターリポジトリも用意されています。テーマの利用にはHugo v0.158以降が必要です。また、SemVer形式のマイナーバージョンを採用しており、リリース間で破壊的変更が入る場合があります。

主な機能

  • 01サイドバーナビゲーションを備えた、すっきりとした書籍風レイアウト
  • 02モバイル対応のレスポンシブデザイン
  • 03多言語サイトに対応
  • 04ドキュメントでよく使われる要素の組み込みショートコード
  • 05主要機能はJavaScriptなしで動作
  • 06ライトモードとダークモード

ユースケース

  • Hugoでプロジェクトや製品のドキュメントを作成する
  • 多言語対応のドキュメントサイトを構築する
  • シンプルな技術ハンドブックやナレッジベースを公開する

クイックスタート

  1. 1

    スターターリポジトリをクローンする

    git clone https://github.com/alex-shpak/hugo-book-starter my-docs
  2. 2

    プロジェクトフォルダーに移動する

    cd my-docs
  3. 3

    テーマのサブモジュールを取得する

    git submodule update --init --remote
  4. 4

    Hugoの開発サーバーを起動する

    hugo server --minify

使う前に知っておきたいこと

  • リリース間で破壊的変更が予想されるため、アップデート時にサイトの変更が必要になる場合があります。

トピック

よくある質問

hugo-book とは?
Hugo向けの、シンプルでモバイル対応の、書籍のようなデザインのドキュメントテーマ。 Hugo Bookは、Markdownコンテンツをすっきりとした書籍風レイアウトのドキュメントサイトに変換する、Hugo向けのテーマです。サイドバーのツリーナビゲーション、検索しやすい構造、ライトモードとダークモードを備え、初期設定なしですぐに使えるよう設計されています。
hugo-book は無料で使えますか?ライセンスは?
hugo-book は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
hugo-book は今もメンテナンスされていますか?
活発にメンテナンス中。hugo-book の最終コミットは 2026年10月21日 です。
hugo-book は何に使えますか?
Hugoでプロジェクトや製品のドキュメントを作成する 多言語対応のドキュメントサイトを構築する シンプルな技術ハンドブックやナレッジベースを公開する
hugo-book のインストール方法は?
スターターリポジトリをクローンする: git clone https://github.com/alex-shpak/hugo-book-starter my-docs プロジェクトフォルダーに移動する: cd my-docs テーマのサブモジュールを取得する: git submodule update --init --remote Hugoの開発サーバーを起動する: hugo server --minify
hugo-book はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/alex-shpak/hugo-book

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト