Docs Overview

The docs module provides the basic layouts and templates for docs site, it’s useful for writing project documentation, 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.
navs_borderbooleantrueWhether to show the left border for sub navs.

params.toml

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

params.yaml

1params:
2  hb:
3    docs:
4      date_format: :date_long
5      navs_border: true

params.json

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

Page Parameters

NameTypeDefaultDescription
commentsbooleantrueWhether to display the comments.
metaboolean/objecttrueWhen false then disable all meta.
meta.authorsbooleantrueWhen false then disable the authors meta.
meta.datebooleantrueWhen false then disable the date meta.
meta.reading_timebooleantrueWhen false then disable the reading time meta.
meta.taxonomiesbooleantrueWhen false then disable the taxonimies meta: series, categories and tags.
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.
nav_menusobject-Extra external menus, works only on sections.
nav_menus.nameobject-Extra menu name.
nav_menus.urlobject-Extra menu URL.
nav_menus.iconobject-Extra menu’s icons.
redirectstring-URL of external documentation.
razonyang
Sunday, June 16, 2024 Friday, March 31, 2023