OKF Tutorial
Use the main tutorial for the full workflow.
Open pageHow-to guide
How to add YAML frontmatter for OKF
Add YAML frontmatter by placing a metadata block at the top of the Markdown file before the first heading.
Short answer
Add YAML frontmatter by placing a metadata block at the top of the Markdown file before the first heading.
Prerequisites
- A Markdown file or source page to convert.
- A clear concept boundary.
- A canonical source URL or stable resource identifier.
- Access to the OKF Validator for structure checks.
Step-by-step tutorial
- Start the file with ---.
- Add type, title, description, resource, tags, and timestamp.
- Close the block with ---.
- Write the Markdown body.
- Validate the file.
Copyable example
---
type: Documentation Topic
title: Add YAML frontmatter
description: Explains required and recommended metadata fields.
resource: https://openknowledgeformat.online/guides/how-to-add-yaml-frontmatter-for-okf/
tags: [okf, guide, example]
timestamp: 2026-06-21T00:00:00Z
---
# Purpose
Explain the stable facts, boundaries, owner notes, and related links for this concept.
# Links
- Validator: https://openknowledgeformat.online/okf-validator/
- Examples: https://openknowledgeformat.online/okf-examples/Common mistakes
- Trying to cover too many concepts in one file.
- Leaving metadata blank or vague.
- Treating validation as proof that every claim is correct.
- Publishing private or unreviewed information.
Validation method
- Paste the file into the OKF Validator.
- Fix errors before warnings.
- Check links and source claims manually.
- Add the file to the bundle index.
Related page links
- OKF Tutorial for the full beginner workflow.
- OKF Examples for bundle structures.
- OKF Templates for copyable starting points.
FAQ
Common questions
Does this require a database?
No. A folder of Markdown files is enough for the first version.
Can I automate this?
You can generate drafts, but owners should review source accuracy and boundaries.