Docs Overview

March 31, 2023 2 min read Modules Docs Docs

Donate

Become a backer or sponsor to support our work.

On this page

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.
`navs_border`	boolean	`true`	Whether to show the left border for sub navs.
`navs_reduce_font_size`	boolean	`true`	Whether to reduce submenu’s font size.
`navs_sticky_scroll`	boolean	`true`	When `true`, the ancestors will be sticky on scroll.
`navs_active_style`	string	-	Active style for navs item, empty or `bordered`.

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

Name	Type	Default	Description
`comments`	boolean	`true`	Whether to display the comments.
`docs_root_section`	boolean	`true`	When `false` on First Section, then the second section will be used as the root section of navigation.
`meta`	boolean/object	`true`	When `false` then disable all meta.
`meta.authors`	boolean	`true`	When `false` then disable the authors meta.
`meta.date`	boolean	`true`	When `false` then disable the date meta.
`meta.reading_time`	boolean	`true`	When `false` then disable the reading time meta.
`meta.taxonomies`	boolean	`true`	When `false` then disable the taxonimies meta: series, categories and tags.
`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.
`nav_menus`	object	-	Extra external menus, works only on sections.
`nav_menus.name`	object	-	Extra menu name.
`nav_menus.url`	object	-	Extra menu URL.
`nav_menus.icon`	object	-	Extra menu’s icons.
`redirect`	string	-	URL of external documentation.

View the page source Edit the page History

Saturday, December 21, 2024 Friday, March 31, 2023

Revision

Browse Modules

Docs Overview

Site Parameters

Page Parameters