Getting Started
Core Features
How-To Guides
Integrations
Troubleshooting
Writing content in the system allows you to manage both the body text of your documents and supplementary metadata using a standard format. By using a structured header at the top of your document, you can define specific properties that help organize and identify your content.
Frontmatter is a block of text at the very top of your file that contains settings or details about the document, such as the title, date, or author. The system automatically separates this information from the main body of your text.
To use frontmatter, you must place your settings between two lines consisting of three dashes (---). The content inside must be formatted in YAML, which is a simple way of listing labels and values.
---.title: My Document).--- on a new line to close the metadata block.--- line.key: value structure.Here is how your document should look when using frontmatter:
---
title: How to Write Content
date: 2023-10-27
author: Jane Doe
---
# Welcome
This is the main content of your document. The text above is the metadata.Important
The frontmatter block must start on the very first line of your file. If you have any empty spaces or lines before the first set of three dashes, the system will not recognize the metadata.
Warning
Ensure you use exactly three dashes (---) for both the opening and closing delimiters. If the formatting is incorrect, the system will treat your metadata as part of the main document text.
Tip
Keep your metadata keys and values simple. Use one line per property, such as category: Tutorial or published: true.