Core Module Configuration

Site parameters and page parameters of HB core module.

Site Parameters

css_bundle_name

NameContextTypeRequiredDefaultSince
css_bundle_nameparasm.hbstring-hb-

The bundle name of CSS.

color

NameContextTypeRequiredDefaultSince
colorparasm.hbstring-light-

Default color.

Available options: light, dark.

debug

NameContextTypeRequiredDefaultSince
debugparasm.hbboolean-false-

Whether to enable debug mode.

js_bundle_name

NameContextTypeRequiredDefaultSince
js_bundle_nameparasm.hbstring-hb-

The bundle name of JS.

NameContextTypeRequiredDefaultSince
logoparasm.hbstring-images/logo.png-

The logo path relative to assets folder.

full_width

NameContextTypeRequiredDefaultSince
full_widthparasm.hbboolean/array-false-

Whether to take full width, a boolean value or array of first level sections, e.g. ["docs", "blog"].

full_width_types

NameContextTypeRequiredDefaultSince
full_width_typesparasm.hbobject---

The content types to take full width, used by modules.

Site Parameters Example

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}

Page Parameters

full_width

NameContextTypeRequiredDefaultSince
full_widthparamsboolean-false-

When true then the current page takes full width, otherwise fallback to the site’s full_width.

Page Parameters Example

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
Monday, July 15, 2024 Wednesday, April 24, 2024