# alex-shpak/hugo-book

Hugo documentation theme as simple as plain book

Repository: https://github.com/alex-shpak/hugo-book
Canonical: https://ross.abutalabs.com/products/hugo-book
Homepage: https://book.alxs.dev
Language: HTML
License: MIT
License Family: permissive
Topics: hugo, hugo-theme, documentation, markdown
Last push: 2026-08-24T21:36:19+00:00

## Health v2 (maintenance only)
Score: 86/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 99, release rhythm 61, longevity 100
- inputs: {"age_days": 2919, "days_push": 9, "days_rel": 103, "gap_med": 119, "n_releases_24m": 4}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 4089, forks 1314 (observed 2026-08-28T04:08:34.556838+00:00)

## What it is
Hugo Book is a minimal, book-style documentation theme for the Hugo static site generator. It provides a sidebar file-tree menu, full-text search, multi-language support, and handy shortcodes (tabs, columns, KaTeX, Mermaid, images, Asciinema) with core features working without JavaScript.

## Use cases
- build a documentation site for an open-source project
- create a technical docs site with Hugo
- publish a multi-language documentation website
- host searchable markdown documentation as a static site
- make a simple book-style knowledge base
- add math and diagrams to documentation pages

## When to choose
- you use Hugo and want a clean, minimal docs theme with zero initial configuration
- you want documentation that works largely without JavaScript
- you need multi-language docs, search, tabs, KaTeX, or Mermaid out of the box
- you value a small, extendable, low-maintenance theme codebase

## When to avoid
- you need a feature-heavy docs platform like Docusaurus or MkDocs Material with versioned docs and i18n workflows
- your site is not built with Hugo
- you want a blog-first or marketing-site theme rather than a docs layout
- you need breaking-change-free upgrades, since minor releases may include breaking changes

## Facets
- artifact type: plugin
- maturity: active
- function: static-site-generator, documentation, search-engine, templating, markdown
- domain: documentation, web-development, frontend
- platform: cross-platform
- tags: hugo-theme, docs-theme, static-site, dark-mode, multilingual, shortcodes, katex, mermaid, web-server

## Member repositories
- alex-shpak/hugo-book (main) score 86

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:08:34.556838+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-29T18:23:22.061109+00:00, confidence not recorded.
  - readme: https://github.com/alex-shpak/hugo-book (fetched 2026-08-28T04:08:34.556838+00:00, sha 8ecec6f81fe2)
  - homepage: https://book.alxs.dev (fetched 2026-08-29T09:15:12.166393+00:00, sha e0fae3185642)
  - site_page: https://book.alxs.dev/docs/content/shortcodes/experimental/images (fetched 2026-08-29T09:15:12.190668+00:00, sha d1c1d5508e4a)
  - site_page: https://book.alxs.dev/docs/getting-started/introduction (fetched 2026-08-29T09:15:12.185054+00:00, sha 2f75b287829c)
  - site_page: https://book.alxs.dev/docs/content/shortcodes/columns (fetched 2026-08-29T09:15:12.187178+00:00, sha 52005ef25158)
  - site_page: https://book.alxs.dev/docs/content/shortcodes/tabs (fetched 2026-08-29T09:15:12.188949+00:00, sha c61aee9c2b93)
  - site_page: https://book.alxs.dev/docs/content/shortcodes/asciinema (fetched 2026-08-29T09:15:12.192331+00:00, sha d48361582944)
  - site_page: https://book.alxs.dev/docs/content/shortcodes/katex (fetched 2026-08-29T09:15:12.194133+00:00, sha 4a5e6d3e7fc5)
  - site_page: https://book.alxs.dev/docs/content/shortcodes/mermaid (fetched 2026-08-29T09:15:12.195694+00:00, sha 5fd924dd90d8)
- Data as of 2026-08-30T08:39:29.467469+00:00.