Skip to content
OKOKF Tools

Index files

index.md is reserved and may appear at any directory level, including the bundle root, for progressive disclosure — you see what's available without opening each document.

Official OKF specification requirement

Index files contain no frontmatter at all. The one exception is the root index.md, which may declare exactly okf_version (e.g. okf_version: "0.2") and nothing else.

Official OKF specification requirement

A missing index.md is not a conformance error.

Example

# Metrics

- [Revenue](metrics/revenue.md) - Recognized company revenue.
- [Gross Profit](metrics/gross-profit.md) - Revenue minus cost of goods sold.

Use the Index Generator to create or refresh these automatically from concept titles and descriptions.