Docs Overview

The docs module provides the basic layouts and templates for docs site, it’s useful for writing project documentations, digital garden, users guides and tutorials.

Modulegithub.com/hbstack/docs
Repository⭐ Please consider giving a star if your like it.
Stars
Version
Used by
Requirements
License
UsageSee how to use modules.

Site Parameters

ParameterTypeDefaultDescription
date_formatstring:date_longDate format.

params.toml

1[params]
2  [params.hb]
3    [params.hb.docs]
4      date_format = ':date_long'

params.yaml

1params:
2  hb:
3    docs:
4      date_format: :date_long

params.json

1{
2   "params": {
3      "hb": {
4         "docs": {
5            "date_format": ":date_long"
6         }
7      }
8   }
9}

Page Parameters

NameTypeDefaultDescription
commentsbooleantrueWhether to display the comments.
nav_weightnumber-The weight of docs nav, sort by link title if not set.
nav_iconobject-The icon shown on the docs nav.
nav_icon.vendorstring-The icon vendor.
nav_icon.namestring-The icon name.
nav_icon.colorstring-The icon color.
nav_icon.classNamestring-The icon CSS class names.
redirectstring-URL of external documentation.