Skip to content

Frontmatter

Frontmatter is metadata at the start of a note — YAML enclosed by --- delimiters, or TOML enclosed by +++ delimiters.

Basic Format

---
description: A brief description of this note
tags:
- tag1
- tag2
---

TOML Frontmatter

TOML frontmatter is fully supported as an alternative, using +++ delimiters:

+++
description = "A brief description of this note"
tags = ["tag1", "tag2"]
+++

Required Fields

For dev-kiln documentation, these fields are required:

FieldTypeDescription
titlestringDisplay title for the note
descriptionstringBrief summary (1-2 sentences)
tagslistCategorization tags

title and tags are extracted and indexed (titles participate in wikilink resolution; tags are searchable via property_search). description is only read as a typed field for task files and workflow notes; on ordinary notes it is stored as a generic property like any other.

Conventional Fields

These fields are conventions carried over from Obsidian-style vaults. Crucible stores them as generic queryable properties (available via property_search), but their special semantics are not implemented:

FieldTypeConventionStatus
ordernumberSort order within a folderStored only — nothing sorts by it
aliaseslistAlternative names for wikilink resolutionStored only — wikilink resolution does not consult aliases
createddateCreation timestampStored only — no date handling
modifieddateLast modification timestampStored only — no date handling

Example

---
description: Your first steps with Crucible
tags:
- guide
- beginner
order: 1
aliases:
- quickstart
- intro
---
# Getting Started
Your content here...

See Also