close
Skip to content

alex-shpak/hugo-book

Repository files navigation

Hugo Book Theme

Hugo License: MIT Build with Hugo

Hugo documentation theme as simple as plain book

Screenshot

Features

  • Clean simple design
  • Light and Mobile-Friendly
  • Multi-language support
  • Customisable
  • Zero initial configuration
  • Handy shortcodes
  • Comments support
  • Simple blog and taxonomy
  • Primary features work without JavaScript
  • Dark Mode

Quick Start

Use the starter repository:

git clone https://github.com/alex-shpak/hugo-book-starter my-docs
cd my-docs
git submodule update --init --remote
hugo server --minify

Requirements

  • Hugo extended edition, v0.158 or higher

Documentation

Example site is self-documenting at book.alxs.dev

Versioning

This theme follows a simple incremental versioning. e.g. v1.0.0, v2.0.0 and so on. Releases will happen on breaking changes.

If you want lower maintenance, use one of the released versions. If you want to live on the bleeding edge of changes, you can use the main branch and update your website when needed, this also the default branch.

Contributing

Contributions are welcome and I will review and consider pull requests.
Primary goals are:

  • Keep it simple.
  • Keep minimal (or zero) default configuration.
  • Avoid interference with user-defined layouts.
  • Avoid using JS if it can be solved by CSS.

Feel free to open issues if you find missing configuration or customisation options.

About

Hugo documentation theme as simple as plain book

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Contributors