核心模塊配置

HB 核心模塊的站點參數和頁面參數。

站點參數

css_bundle_name

名稱上下文類型必填默認值版本示例
css_bundle_nameparams.hbstring-hb--

CSS 文件名稱。

color

名稱上下文類型必填默認值版本示例
colorparams.hbstring-light--

默認顏色主題。

可選項:light, dark

debug

名稱上下文類型必填默認值版本示例
debugparams.hbboolean-false--

是否開啟調試模式。

js_bundle_name

名稱上下文類型必填默認值版本示例
js_bundle_nameparams.hbstring-hb--

JS 文件名稱。

名稱上下文類型必填默認值版本示例
logoparams.hbstring-images/logo.png--

Logo 路徑,相對於 assets 目錄。

full_width

名稱上下文類型必填默認值版本示例
full_widthparams.hbboolean/array-false--

是否全寬,其為布爾值或者第一層級的欄目數值,如 ["docs", "blog"]

full_width_types

名稱上下文類型必填默認值版本示例
full_width_typesparams.hbobject----

哪些內容類型佔據全寬,被用於模塊。

sass_transpiler

名稱上下文類型必填默認值版本示例
sass_transpilerparams.hbstring-dartsass--

Sass 編譯器。

可選項:dartsass, libsass

sass_silence_deprecations

名稱上下文類型必填默認值版本示例
sass_silence_deprecationsparams.hbarray----

用於過濾棄用警告,比如:["import"]

站點參數示例

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_widthparamsboolean-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}
razonyang
2024年12月9日 星期一 2024年4月24日 星期三