Repolode
Submit
alex-shpak

alex-shpak/hugo-book

A simple, mobile-friendly documentation theme for the Hugo static site generator, styled after a plain book.

View on GitHubWebsite
Stars
4,097
Forks
1,311
Open issues
8
Last commit
yesterday

What is it?

Hugo Book is a theme for the Hugo static site generator that turns Markdown content into a documentation site with a clean, book-like layout. It provides a sidebar navigation tree, search-friendly structure, and a light and dark mode, and it is designed to work with zero initial configuration.

The theme includes built-in shortcodes for common documentation elements, supports multi-language sites, and offers simple blog and taxonomy pages. Its core features work without JavaScript, and the project aims to avoid interfering with user-defined layouts and to prefer CSS over JS where possible.

A starter repository is available for a quick setup. The theme requires Hugo v0.158 or higher and uses SemVer-style minor versions, with breaking changes expected between releases.

Key features

  • 01Clean, book-style layout with sidebar navigation
  • 02Mobile-friendly and responsive design
  • 03Multi-language site support
  • 04Built-in shortcodes for common documentation elements
  • 05Core features work without JavaScript
  • 06Light and dark mode

Use cases

  • Building project or product documentation with Hugo
  • Creating a multi-language documentation site
  • Publishing a simple technical handbook or knowledge base

Quick start

  1. 1

    Clone the starter repository

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

    Enter the project folder

    cd my-docs
  3. 3

    Fetch the theme submodule

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

    Start the Hugo development server

    hugo server --minify

Things to know

  • Breaking changes are expected between releases, so updates may require site changes.

Topics

#documentation#hugo#hugo-theme#markdown#static-site

FAQ

What is hugo-book?
A simple, mobile-friendly documentation theme for the Hugo static site generator, styled after a plain book. Hugo Book is a theme for the Hugo static site generator that turns Markdown content into a documentation site with a clean, book-like layout. It provides a sidebar navigation tree, search-friendly structure, and a light and dark mode, and it is designed to work with zero initial configuration.
Is hugo-book free to use? What license does it have?
hugo-book is open source under the MIT license. Check the license terms before using it in commercial products.
Is hugo-book still maintained?
Actively maintained. The last commit to hugo-book was on Oct 21, 2026.
What can I use hugo-book for?
Building project or product documentation with Hugo Creating a multi-language documentation site Publishing a simple technical handbook or knowledge base
How do I install hugo-book?
Clone the starter repository: git clone https://github.com/alex-shpak/hugo-book-starter my-docs Enter the project folder: cd my-docs Fetch the theme submodule: git submodule update --init --remote Start the Hugo development server: hugo server --minify
Where can I get hugo-book?
The source code and installation instructions are on GitHub: https://github.com/alex-shpak/hugo-book

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects