Open Knowledge Format – Unofficial Community Guide & Interactive Showcase

Knowledge Bundles

A bundle is a folder you distribute – Git repo, ZIP, or tarball. An index.md maps the contents, a log.md records changes.

Concept Files

One Markdown file per concept. YAML frontmatter with at least type. The file path (minus .md) becomes the concept ID.

Linked Concepts

Standard Markdown links assert relationships. The prose around the link explains what kind. A # Citations section tracks external sources.

index.md

markdown

Metrics

SaaS Metrics

Metrics, source tables, dashboards, and review playbooks as linked concepts.

okf/ ├── index.md ├── metrics/mrr.md ├── tables/subscriptions.md └── playbooks/revenue-review.md

APIs

API Documentation

Endpoints, schemas, errors, and auth without replacing OpenAPI.

okf/ ├── index.md ├── endpoints/create-customer.md ├── schemas/customer.md └── errors/rate-limit.md

Framework

Laravel App

Routes, models, policies, jobs, and operational context for humans and agents.

okf/ ├── index.md ├── models/user.md ├── routes/api-users.md └── policies/user-policy.md

CMS

WordPress Site

Custom post types, taxonomies, ACF fields, and templates as portable knowledge.

okf/ ├── index.md ├── post-types/product.md ├── acf/product-fields.md └── templates/single-product.md

Data

Data Warehouse

Datasets, tables, metrics, lineage, and data quality notes near the systems they describe.

okf/ ├── index.md ├── datasets/sales.md ├── tables/orders.md └── metrics/gross-revenue.md

AI

Agent Context

Give agents durable context about systems, tools, playbooks, and constraints before they act.

okf/ ├── index.md ├── systems/billing.md ├── tools/stripe-api.md └── constraints/rate-limits.md

Parseability

Built for both worlds

Humans get readable documents. Agents get structured JSON.

Monthly Recurring Revenue

Metric • [revenue, saas, finance]

Calculation
Sum of active subscription amounts.

{ "type": "Metric", "title": "Monthly Recurring Revenue", "tags": ["revenue", "saas"], "body": "# Calculation\\nSum of active subscription amounts." }

Ecosystem

3 lines of code

No specialized SDK required. Use the Markdown libraries you already know.

import frontmatter # Parse the OKF file concept = frontmatter.load('okf/metrics/mrr.md') # Access metadata and body print(concept['type']) # -> 'Metric' print(concept.content) # -> '# Calculation...'

const matter = require('gray-matter'); // Parse the OKF file const concept = matter.read('okf/metrics/mrr.md'); // Access metadata and body console.log(concept.data.type); // -> 'Metric' console.log(concept.content); // -> '# Calculation...'

Editor 0 chars

Preview

Start typing or load a preset…

Waiting for input

Feature	OKF	RAG Chunks	OpenAPI	JSON-LD	Wiki / Docs
Human-readable	✓	✗	△	✗	✓
Agent-parseable	✓	△	✓	✓	✗
Structured metadata	✓	✗	✓	✓	✗
Cross-concept links	✓	✗	△	✓	△
Git-friendly	✓	△	✓	✓	✗
No server required	✓	✗	✓	✓	✗
Domain-agnostic	✓	✓	✗	✓	✓
Portable (ZIP / Git)	✓	✗	✓	△	✗

FAQ

Frequently Asked Questions

Why not just use plain Markdown?

Plain Markdown is great for humans, but terrible for agents. Without structured metadata (like YAML frontmatter), agents struggle to confidently categorize concepts or extract properties like resource URIs and tags.

Do I need a special parser?

No! OKF uses standard YAML frontmatter and standard Markdown syntax. Any existing library that parses frontmatter (like gray-matter for JS, or python-frontmatter) will parse an OKF file perfectly.

How does this differ from RAG or vector databases?

OKF is a storage format, not an execution engine. You can parse OKF bundles into a RAG pipeline or a vector database. OKF simply gives you a standardized way to author, version, and share the knowledge before it gets vectorized.

01

Create the bundle folder

Add an okf/ directory in your repo, project, or export location.

mkdir okf

02

Add a root index

List your concept groups so humans and agents can scan the bundle at a glance.

# okf/index.md --- okf_version: "0.1" --- # Metrics * [MRR](metrics/mrr.md)

03

Create a concept file

One Markdown file per concept. Give it YAML frontmatter with at least a type.

# okf/metrics/mrr.md --- type: Metric title: Monthly Recurring Revenue --- # Calculation Sum of active subscription amounts.

04

Add metadata

Enrich with description, resource, tags, and timestamp when useful.

description: Recurring revenue normalized monthly. resource: dashboard://revenue/mrr tags: [revenue, saas, finance] timestamp: 2026-06-13T00:00:00Z

05

Link related concepts

Use standard Markdown links. Add # Citations for external sources.

MRR is calculated from the [subscriptions table](/tables/subscriptions.md). # Citations [1] [Revenue dashboard](dashboard://revenue/mrr)

06

Ship it

Commit the folder, ship as an archive, or expose it to an agent or catalog.

git add okf/ git commit -m "Add OKF knowledge bundle" git push

Portable knowledge bundles for humans and AI agents.

Three building blocks