浏览模块

文档概览

2023年3月31日 1 分钟阅读 模块 文档
本页内容
赞助

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

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.

站点参数

ParameterTypeDefaultDescription
date_formatstring:date_long日期格式。
navs_borderbooleantrue是否为深层导航显示左侧边框。

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}

页面参数

NameTypeDefaultDescription
commentsbooleantrue是否显示评论。
metaboolean/objecttrue为 false 时，禁用所有元信息。
meta.authorsbooleantrue为 false 时，禁用作者元信息。
meta.datebooleantrue为 false 时，禁用日期元信息。
meta.reading_timebooleantrue为 false 时，禁用阅读时长元信息。
meta.taxonomiesbooleantrue为 false 时，禁用专栏、分类和标签元信息。
nav_weightnumber-文档导航的权重，若未设置，则按链接标题排序。
nav_iconobject-显示于文档导航的图标。
nav_icon.vendorstring-图标提供商。
nav_icon.namestring-图标名称。
nav_icon.colorstring-图标颜色。
nav_icon.classNamestring-图标 CSS 类名。
nav_menusobject-额外的外部菜单，仅对栏目有效。
nav_menus.nameobject-额外菜单名称。
nav_menus.urlobject-额外菜单 URL。
nav_menus.iconobject-额外菜单图标。
redirectstring-外部文档的 URL。