文档概览

2023年3月31日 1 分钟阅读模块文档

本页内容

文档模块为文档站点提供了基本的布局和模板，其对于编写项目文档、数字花园、用户指南、教程等十分实用。

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.

站点参数

Parameter	Type	Default	Description
`date_format`	string	`:date_long`	日期格式。

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}

Name	Type	Default	Description
`comments`	boolean	`true`	是否显示评论。
`nav_weight`	number	-	文档导航的权重，若未设置，则按链接标题排序。
`nav_icon`	object	-	显示于文档导航的图标。
`nav_icon.vendor`	string	-	图标提供商。
`nav_icon.name`	string	-	图标名称。
`nav_icon.color`	string	-	图标颜色。
`nav_icon.className`	string	-	图标 CSS 类名。
`redirect`	string	-	外部文档的 URL。