Docs Overview

March 31, 2023 1 min read Modules Docs Docs

On this page

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.

Module	`github.com/hbstack/docs`
Repository	⭐ Please consider giving a star if your like it.
Stars
Version
Used by
Requirements
License
Usage	See how to use modules.

Site Parameters

Parameter	Type	Default	Description
`date_format`	string	`:date_long`	Date 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

Name	Type	Default	Description
`comments`	boolean	`true`	Whether to display the comments.
`nav_weight`	number	-	The weight of docs nav, sort by link title if not set.
`nav_icon`	object	-	The icon shown on the docs nav.
`nav_icon.vendor`	string	-	The icon vendor.
`nav_icon.name`	string	-	The icon name.
`nav_icon.color`	string	-	The icon color.
`nav_icon.className`	string	-	The icon CSS class names.
`redirect`	string	-	URL of external documentation.

Breadcrumb

Browser docs

Docs Overview

Site Parameters

Page Parameters