Configuration Schema

Type: object

Describes the properties a configuration can use

Root base_url
Type: string

The url to use when using the full_url filter and populating open graph data

Root cache_enabled
Type: boolean

Whether to cache output

Root log_level
Type: enum (of string)
Default: "info"

The max log level to output

Must be one of:

  • "debug"
  • "info"
  • "warning"
  • "critical"

Root themes
Type: object

Describes the themes for various frameworks we use

No Additional Properties

Root themesbootstrap
Type: string
Default: "https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/css/bootstrap.min.css"

The link to the Bootstrap 5 theme you want to use

Examples:

"https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/css/bootstrap.min.css"
"https://bootswatch.com/5/darkly/bootstrap.min.css"

Root themeshighlight_js
Type: string
Default: "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.4.0/styles/default.min.css"

The link to the highlight.js theme you want to use

Examples:

"https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.4.0/build/styles/github-dark-dimmed.min.css"
"https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.4.0/build/styles/github.min.css"

Root themestheme
Type: enum (of string)
Default: "light"

Whether to use a dark or light bg- class in various places

Must be one of:

  • "dark"
  • "light"

Root brand
Type: object

Root brandapp_name
Type: string
Default: "My App"

Name of your website, will be displayed on the navbar and included in various metadata

Root brandshort_name
Type: string
Default: "My App"

Short name of the site; used where space is limited.

Root brandfavicon_folder
Type: string

The static folder to reference for various favicons, see Favicon Generator

Examples:

"fav/"
"images/favicons/"

Root brandnavbar_icon
Type: string

The static file to use for the navbar brand icon

Examples:

"images/navbar_icon.png"
"images/navbar_icon.webp"

Root brandnavbar_icon_size
Type: array of integer

Size (X, Y) of your navbar icon

Must contain a minimum of 2 Items

Must contain a maximum of 2 Items

Each item of this array must be:

Root brandnavbar_icon_sizenavbar_icon_size items
Type: integer

Value must be greater or equal to 0

Examples:

[
    100,
    100
]
[
    30,
    50
]

Root brandsocials
Type: array of object

A list of social media icons to put in the navbar

Each item of this array must be:

Root brandsocialssocials items
Type: object

Root brandsocialssocials itemsname
Type: string

Name of the social media platform (used for accessibility and on mobile)

Examples:

"Twitter"
"Discord"

Root brandsocialssocials itemsicon
Type: string

The Boostrap Icon class to use for the link (omit the bi-)

Examples:

"twitter"
"discord"
"github"

Root brandshow_gen_date
Type: boolean
Default: true

Whether to show a message in the footer stating what time and date the site was last generated

Root brandmeta
Type: object

describes various settings for meta html tags

Root brandmetasearch_console_code
Type: string

Code for verifying site ownership in google search console. Select "HTML Tag Verification" on the search console. (Alternatively, you can add an html file generated by search console as a static file)

Root brandmetadescription
Type: string

The description to use when linking the homepage or if no description is provided on a page

Example:

"Check out my cool app!"

Root brandmetakeywords
Type: array of string

Keywords used by search engines to find the site

Each item of this array must be:

Root brandmetakeywordskeywords items
Type: string

Examples:

[
    "C#",
    "Unity",
    "Cool"
]
[
    "Python",
    "Jinja2",
    "Documentation"
]

Root brandmetacategories
Type: array of string
Default: []

See the list of widely used categories

Each item of this array must be:

Root brandmetacategoriescategories items
Type: string

Example:

[
    "books",
    "education"
]

Root brandmetaimage
Type: string

The path to the image to use when generating embeds

Examples:

"images/logo.png"
"images/logo.webp"

Root brandmetaimage_alt
Type: string
Default: "Logo"

The alt text to put on the image when it's embedded

Example:

"Logo for my cool app"

Root brandmetatheme_color
Type: string
Default: "#666666"

See The MDN docs on theme color

Examples:

"#ffffff"
"#000000"

Root brandmetabg_color
Type: string
Default: "#666666"

Background color used for various styling in the browser

Examples:

"#ffffff"
"#000000"

Root styles
Type: object

Add styles

Root stylesbase
Type: string

Use a CSS file on every page

Example:

"styles/my_cool_base_style.css"

Root stylesschema
Type: string

Use a CSS file on schema pages

Example:

"styles/my_cool_schema_style.css"

Root default_toc
Type: boolean
Default: true

Whether to render a table of contents for each page (except schemas) by default

Root folders
Type: object

Various folders to pull/push from/to

Root foldersout
Type: string
Default: "out/"

The folder to output to

Examples:

"output/"
"build/"
"docs/"

Root folderscontent
Type: string
Default: "content/"

The folder to use as the root for content of the site, this has the pages, static, and meta folders in it

Examples:

"stuff/"
"data/"

Root folderspages
Type: string
Default: "pages/"

The name of the folder within content to scan for pages to render

Example:

"cool_stuff/"

Root foldersstatic
Type: string
Default: "static/"

The name of the folder within content to scan for static files to copy over

Example:

"media/"

Root folderscache
Type: string
Default: ".m_cache/"

The name of the folder to put caches in

Example:

".cache/"

Root minify
Type: object

Set whether to minify various files

Root minifyhtml
Type: boolean
Default: true

Whether to minify HTML (including rendered schemas and markdown) files

Root minifycss
Type: boolean
Default: true

Whether to minify CSS files

Root minifyjs
Type: boolean
Default: true

Whether to minify JS files

Root minifyxml
Type: boolean
Default: true

Whether to minify XML files

Root minifyjson
Type: boolean
Default: true

Whether to minify JSON files

Root extras
Type: object
Default: {}

Any additional properties you wish to store, these can be inserted by using the settings dictionary in pages (See Built-In Filter & Globals Reference on the pages page for more info).