Frontmatter
Frontmatter is YAML metadata at the start of a note, enclosed by --- delimiters.
Basic Format
Section titled “Basic Format”---description: A brief description of this notetags: - tag1 - tag2---Required Fields
Section titled “Required Fields”For dev-kiln documentation, these fields are required:
| Field | Type | Description |
|---|---|---|
title | string | Display title for the note |
description | string | Brief summary (1-2 sentences) |
tags | list | Categorization tags |
Optional Fields
Section titled “Optional Fields”| Field | Type | Description |
|---|---|---|
order | number | Sort order within a folder |
aliases | list | Alternative names for wikilink resolution |
created | date | Creation timestamp |
modified | date | Last modification timestamp |
Example
Section titled “Example”---description: Your first steps with Crucibletags: - guide - beginnerorder: 1aliases: - quickstart - intro---
# Getting Started
Your content here...Parsing
Section titled “Parsing”Crucible parses frontmatter using the parser module in crucible-core:
- Implementation:
crates/crucible-core/src/parser/(frontmatter parsing) - Types:
crates/crucible-core/src/parser/types/frontmatter.rs