核心模块配置
HB 核心模块的站点参数和页面参数。
赞助
成为我们的资助者或赞助商，以支持我们的工作。
本页内容
赞助商
站点参数
css_bundle_name
| 名称 | 上下文 | 类型 | 必填 | 默认值 | 版本 | 示例 |
|---|---|---|---|---|---|---|
css_bundle_name | params.hb | string | - | hb | - | - |
CSS 文件名称。
color
| 名称 | 上下文 | 类型 | 必填 | 默认值 | 版本 | 示例 |
|---|---|---|---|---|---|---|
color | params.hb | string | - | light | - | - |
默认颜色主题。
可选项：light, dark。
debug
| 名称 | 上下文 | 类型 | 必填 | 默认值 | 版本 | 示例 |
|---|---|---|---|---|---|---|
debug | params.hb | boolean | - | false | - | - |
是否开启调试模式。
js_bundle_name
| 名称 | 上下文 | 类型 | 必填 | 默认值 | 版本 | 示例 |
|---|---|---|---|---|---|---|
js_bundle_name | params.hb | string | - | hb | - | - |
JS 文件名称。
logo
| 名称 | 上下文 | 类型 | 必填 | 默认值 | 版本 | 示例 |
|---|---|---|---|---|---|---|
logo | params.hb | string | - | images/logo.png | - | - |
Logo 路径，相对于 assets 目录。
full_width
| 名称 | 上下文 | 类型 | 必填 | 默认值 | 版本 | 示例 |
|---|---|---|---|---|---|---|
full_width | params.hb | boolean/array | - | false | - | - |
是否全宽，其为布尔值或者第一层级的栏目数值，如 ["docs", "blog"]。
full_width_types
| 名称 | 上下文 | 类型 | 必填 | 默认值 | 版本 | 示例 |
|---|---|---|---|---|---|---|
full_width_types | params.hb | object | - | - | - | - |
哪些内容类型占据全宽，被用于模块。
站点参数示例
params.toml
1[hb]
2 color = 'light'
3 css_bundle_name = 'hb'
4 debug = false
5 full_width = false
6 js_bundle_name = 'hb'
7 logo = 'images/logo.png'
params.yaml
1hb:
2 color: light
3 css_bundle_name: hb
4 debug: false
5 full_width: false
6 js_bundle_name: hb
7 logo: images/logo.png
params.json
1{
2 "hb": {
3 "color": "light",
4 "css_bundle_name": "hb",
5 "debug": false,
6 "full_width": false,
7 "js_bundle_name": "hb",
8 "logo": "images/logo.png"
9 }
10}
页面参数
full_width
| 名称 | 上下文 | 类型 | 必填 | 默认值 | 版本 | 示例 |
|---|---|---|---|---|---|---|
full_width | params | boolean | - | false | - | - |
为 true 时，当前页占用全宽，否则回退到站点 full_width 设置。
页面参数示例
1+++
2[params]
3 full_width = false
4+++
1---
2params:
3 full_width: false
4---
1{
2 "params": {
3 "full_width": false
4 }
5}
