Frontmatter · IOModel Documentation

Reference for frontmatter metadata syntax used in IOModel specifications.

Use frontmatter for page metadata in spec pages.

Frontmatter must be the first block in the file and wrapped in ---.

Available frontmatter keys

The following keys are supported in IOModel specs pages.

Key	Value type	Example	Effect
`title`	string	`title: "Code and Frontmatter"`	Page title in header and sidebar
`description`	string	`description: "Reference page..."`	Subtitle under page title + search summary
`icon`	string	`icon: Code`	Icon near title in sidebar/header
`label`	string	`label: pro`	Badge text key/value shown near title
`label_color`	string	`label_color: orange`	Badge color (used with `label`)
`label_description`	string	`label_description: "Available for Pro Plan users"`	Tooltip text for badge

Full example

---
title: 'API Basics'
description: 'How to call the API safely and consistently.'
icon: BookOpen
label: pro
label_color: orange
label_description: 'Available for Pro Plan users'
---

Open page in edit mode

Click Edit on the page.

Open properties dialog

In the editor toolbar, click Edit Page Properties.

Update metadata fields

Edit description, icon, and add/update additional key/value fields such as label, label_color, label_description.

Save and verify

title is editable from the page title input in editor header. The Edit Page Properties dialog manages description, icon, and additional frontmatter key/value fields.

For inline code and fenced code examples, use the dedicated page: Code Blocks.

Good practices

Keep frontmatter keys lowercase with underscore style (label_color).
Keep metadata values concise and meaningful in navigation/search.
Validate page title, icon, and labels after editing page properties.

Last updated on