Core Module Configuration

Site Parameters

css_bundle_name

The bundle name of CSS.

color

Default color.

Available options: light, dark.

debug

Whether to enable debug mode.

js_bundle_name

The bundle name of JS.

logo

The logo path relative to assets folder.

full_width

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

full_width_types

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

sass_transpiler

The Sass transpiler.

Available options: dartsass, libsass.

sass_silence_deprecations

Used to silence deprecations, e.g. ["import"].

Site Parameters Example

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'

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

 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

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}