Configuration

Tag Descriptions

/src/tags.yaml

To ensure it is clear what each tag is for, we require that all tags have a description. Tag descriptions are short and to-the-point, and you can find them in /src/tags.yaml.

This file is a simple mapping of tag names to their descriptions.

meta: Articles and content relating to this website.

All descriptions must be written using proper English, and end with a full stop/period (.).

Navigation Trees

/src/navigation.yaml

Sometimes, it may be useful to present articles as part of a tree of links. You can find the configuration for this in /src/navigation.yaml.

This file contains a set of navigation trees, stored under a prefix. This prefix refers to the start of a path, wherein all paths that start with the given prefix will show the navigation tree on the page.

A navigation tree is a set of navigation items. Each navigation item contains the following keys:

• path The path to the article to be linked to, relative to the prefix and any parent navigation items. If this is . then the parent's path will be used, whether that's the prefix or a parent navigation item.
• icon An optional icon to display in the navigation tree. Uses the same format as Markdown icons, without the surrounding | characters.
• children An optional list of navigation nodes to be displayed within this node.

Navigation nodes must point to an article, and the navigation node displays the article's title.

If multiple prefixes match the current URL, then the site will use the longest prefix.

# Prefix; all pages starting with /a/meta.
/a/meta:
  # This refers to the article at the prefix, /a/meta.
  - path: .
    icon: lucide/info

    # Articles to display as children of this navigation node.
    children:
      # Refers to the article at /writing under the parent path,
      # so /a/meta/writing.
      - path: writing
        icon: lucide/pencil

      # /a/meta/development.
      - path: development
        icon: lucide/code