Create a Site

Prerequisites

• Hugo
• Git (for theme installation using git submodules)
• Go (for theme installation using Hugo Modules)

Quick Start

Use the starter repository to get a working site in seconds. It can also be used as a GitHub template to create a new repository.

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

By default, the theme renders pages under docs/ section as the sidebar menu. See Content Organisation for details.

Installation Methods

git init
git submodule add https://github.com/alex-shpak/hugo-book themes/hugo-book

theme = 'hugo-book'

git submodule update --remote --merge

hugo mod init github.com/user/my-docs

[module]
[[module.imports]]
  path = 'github.com/alex-shpak/hugo-book'

hugo mod get -u

theme = 'hugo-book'

Minimal Configuration

baseURL = 'https://example.com/'
title = 'My Documentation'
theme = 'hugo-book'

# Required for mermaid and katex shortcodes
[markup.goldmark.renderer]
  unsafe = true

See Configuration for the full list of parameters.