config.toml Specification

This page describes the main website configuration file, config.toml.

The website configuration file uses the TOML format.

Root elements

`https`

https = true # for absolute link generation, turn off for local preview

`address`

address = "ddpub.org"

`title`

title = "NorikiTech"

`subtitle`

subtitle = "Chaotic Software Engineering™"

`language`

language = "en-US"

`theme`

theme = "theme.css" # optional, don't include if you want the default

`time_offset`

time_offset = -3600 # seconds from UTC

`[homepage]` section

Describes the page that is served at the root URL (/) of the website.

Optional. If not specified, the feed is served as the homepage (specifically, the user is redirected to the feed URL).

Example:

[homepage]
id = "202212011301"

`id`

ID of the note. Must be a valid note in the notes directory.

`[notes]` section

Example:

[notes]
id_format = '\d{12}'
id_link_format = '§\d{12}' # Format in Markdown links: [Link](§202212011301), [[§202212011301]]

`id_format`

`id_link_format`

`[feed]` section

Example:

[feed]
tag = "norikitech_feed" # internal tag, does not have to be in [[tags]]
url_prefix = "pub" # optional, defaults to "feed"
id = "202309111632" # additional content over list of notes, optional
title = "Posts" # optional, defaults to "Feed"

`tag`

`[[menu]]` table

All variations of the menu:

# `title` is always required.

[[menu]]
url = "https://ddpub.org"
title = "External URL"

[[menu]]
id = "202308311839"
title = "Note ID"

[[menu]]
tag = "some_tag" # Must be in [[tags]]
title = "Tag page"

[[menu]]
builtin = "tags"
title = "Built-in page with all published tags"

[[menu]]
builtin = "search"
title = "Built-in search page"

[[menu]]
builtin = "feed"
title = "Built-in page with a list of all published notes"

Built-in page

Built-ins:

homepage
feed
search
tags

Named page with ID

Tag

The tag must be published in the [[tags]] table.

URL

`[[tags]]` table

Each entry can have all of the following fields: tag, slug, title, id. Example:

[[tags]]
tag = "ddpub_docs" # Tag in the notes, required
slug = "docs" # Tag slug when published, optional, defaults to original tag
title = "Documentation" # Title is optional, defaults to tag itself
id = "202309092253" # id is optional

Any tags not present in [[tags]] are stripped.

`tag`

Required.

`slug`

The URL slug when published.

Optional. Defaults to the value of tag.

`title`

Display name of the tag.

Optional. Defaults to the value of tag.

`id`

ID of the note providing the description of the tag to be shown on the tag page.

Optional.

DDPub