Gitbook theme for Zola
Branch: master
Clone or download
Latest commit e269cb0 Nov 17, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
content Update book theme to gutenberg 0.4 Jul 31, 2018
sass Building with zola Nov 14, 2018
static Add search Jul 31, 2018
templates Building with zola Nov 14, 2018
.gitignore
LICENSE
README.md
config.toml Update config.toml Nov 17, 2018
screenshot.png
theme.toml Update theme.toml Nov 17, 2018

README.md

book

A theme based on Gitbook, to write documentation or books.

book screenshot

Contents

Installation

First download this theme to your themes directory:

$ cd themes
$ git clone https://github.com/getzola/book.git

and then enable it in your config.toml:

theme = "book"
# Optional, if you want search
build_search_index = true

Usage

Book will generate a book from the files you place in the content directory. Your book can have two levels of hierarchy: chapters and subchapters.

Each chapter should be a section within the Gutenberg site and should have an _index.md file that sets its weight front-matter variable to its chapter number. For example, chapter 2 should have weight = 2. Additionally, each chapter should also set the sort_by = "weight" in its front matter.

Each subchapter should be a page and should have its weight variable set to the subchapter number. For example, subchapter 3.4 should have weight = 4.

Finally, you should create an _index.md file and set the redirect_to front-matter variable to redirect to the first section of your content. For example, if your first section has the slug introduction, then you would set redirect_to = "introduction".

Options

Numbered chapters

By default, the book theme will number the chapters and pages in the left menu. You can disable that by setting the book_numbered_chapters in extra:

book_numbered_chapters = false