Frontmatter

How to write frontmatter for metadata available in DocuBook

Format

markdown
---
title: Frontmatter
description: How to write frontmatter for metadata available in DocuBook
---

your content here...

Metadata

Below is a table of available frontmatter fields for documentation pages:

Field NameTypeRequiredDescription
titlestringYesThe page title, displayed in the header and metadata.
descriptionstringYesA short description of the page, used for SEO and previews.
imagestring (URL)NoURL for the Open Graph image (og:image), used when sharing the page on social media.
datestringNoPublication date in the format 07-04-2026. If omitted, the system uses the file's last modified local time automatically.

Last updated May 4, 2026