mirror of https://github.com/alex-shpak/hugo-book.git synced 2024-11-22 19:39:30 +00:00

Go to file

Alex Shpak 73f26ca60d Fix tables in README.md		2018-09-17 15:19:18 +02:00
archetypes	Fill theme.toml, refactor injection partials	2018-09-12 14:21:46 +02:00
assets	Update README.md	2018-09-17 15:09:51 +02:00
images	Add README.md	2018-09-13 18:07:55 +02:00
layouts	Add README.md	2018-09-13 18:07:55 +02:00
static/css	Refactor partials, layout and sass files	2018-09-11 16:51:27 +02:00
LICENSE	Initial commit	2018-09-05 16:22:04 +02:00
README.md	Fix tables in README.md	2018-09-17 15:19:18 +02:00
theme.toml	Fill theme.toml, refactor injection partials	2018-09-12 14:21:46 +02:00

README.md

Hugo Book Theme

Hugo documentation theme as simple as plain book

Features

Clean simple design
Mobile friendly
Customizable
Designed to not interfere with main website
Zero initial configuration

Installation

Navigate to your hugo website root and run:

git clone git@github.com:alex-shpak/hugo-book.git themes/book

Then run hugo (or set theme: book in configuration file)

hugo server --theme book

Configuration

By default theme will render pages from content/docs section as menu in a tree structure.
You can set title and weight in front matter of pages to adjust order and titles in menu.

You can also use leaf bundle and content of it's index.md as menu.
Enable it by pointing to leaf bundle with BookMenuBundle parameter on Site level.

Site configuration

There are few configuration options you can add to your config.yml|json|toml file

# (Optional) Set this to true if you use captial letters in file names
disablePathToLower: true

params:
  # (Optional, default true) Show or hide table of contents globally
  # You can also specify this parameter per page in front matter
  BookShowToC: true

  # (Optional, default none) Set leaf bundle to render side menu
  # When not specified file structure and weights will be used
  # See https://gohugo.io/content-management/page-bundles/
  BookMenuBundle: /docs/menu

  # (Optional, default docs) Specify section of content to render as menu
  # You can also set value to "*" to render all sections to menu
  BookSection: docs

Per document configuration

You can specify additional params per document in front matter

---
# Set type to 'docs' if you want to render page outside of configured section
type: docs

# Set page weight to re-arrange items in file-tree menu (if BookMenuBundle not set)
weight: 10

# Set to mark page as top level section in file-tree menu (if BookMenuBundle not set)
bookTopSection: true

# Set to hide table of contents, overrides global value
bookShowToC: false
---

Partials

There are few empty partials you can override in layouts/partials/

Partial	Placement
layouts/partials/docs/inject/head.html	Before closing `<head>` tag
layouts/partials/docs/inject/body.html	Before closing `<body>` tag
layouts/partials/docs/inject/nav-before.html	Before `<nav>` menu block
layouts/partials/docs/inject/nav-after.html	After `<nav>` menu block

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

If you missing some configuration or customisation option feel free to open issue.

License

MIT