Copyable templates

Open Knowledge Format Example

See what an OKF bundle looks like before generating your own.

Use these examples to understand concept documents, index files, logs, and citations.

What does an OKF concept look like?
---
type: Web Page
title: Product Docs
description: AI-readable documentation.
---

# Summary

A concise Markdown concept.

Generate OKF from a website

Paste a sitemap or up to 20 page URLs. The tool creates Markdown concepts, an index, a log, and a validation report.

Validate OKF v0.1 Markdown

Check required frontmatter, the required type field, optional quality signals, and internal links.

Frontmatter preview
type: Web Page
title: Example Page
description: A page converted into Open Knowledge Format.

Minimal Open Knowledge Format bundle

An OKF bundle is a directory of Markdown files. Concept documents need YAML frontmatter with a non-empty type field.

my_bundle/
  index.md
  log.md
  concepts/
    product-docs.md

Thin OKF concept

---
type: Web Page
title: Pricing
description: Pricing page.
---

# Summary

Pricing info.

This parses, but it is too vague. It does not explain audience, plan differences, source context, or what an agent should cite.

Better OKF concept

---
type: Web Page
title: Pricing
description: Pricing plans, upgrade paths, and billing context for the product.
resource: https://example.com/pricing
---

# Summary

This page explains the available pricing plans, who each plan is for,
which billing options are available, and what a user should compare before upgrading.

# Citations

[1] [Pricing page](https://example.com/pricing)

This is still concise, but it gives an agent enough context to summarize and cite the page.

Sites using OKF

Approved public submissions appear here after their /okf/index.md passes live validation.

Loading verified sites...

Submit your OKF site

Concept

A single Markdown file with type, title, description, resource, and body content.

Index

A progressive disclosure file that lists concepts before an agent opens every document.

Log

A simple history file for bundle updates and spec migration notes.