Built-in OKF schema
docmeta ships one built-in schema, google:okf:0.1 — the Open Knowledge
Format (OKF) v0.1 frontmatter schema. It is the default
schema: when no --schema, file
$schema, or config rule applies, docmeta validates against google:okf:0.1.
| Property | Value |
|---|---|
| Id | google:okf:0.1 |
| Title | Open Knowledge Format (OKF) v0.1 |
| Dialect | Draft 2020-12 |
| Additional properties | Allowed (additionalProperties: true) |
| Reference kind | builtin |
OKF requires only type. Every other field is recommended, and unknown keys are
explicitly tolerated, so a file may carry extra metadata without failing.
Fields
Section titled “Fields”| Field | Type | Format | Constraint | Status |
|---|---|---|---|---|
type |
string | — | minLength: 1 |
Required |
title |
string | — | — | Recommended |
description |
string | — | — | Recommended |
resource |
string | uri |
— | Recommended |
tags |
array of string | — | — | Recommended |
timestamp |
string | date-time |
— | Recommended |
type— a short string identifying the kind of concept; used for routing, filtering, and presentation. Must be a non-empty string.title— human-readable display name. When omitted, consumers may derive a title from the filename.description— single-sentence summary used for indexing and previews.resource— a URI uniquely identifying the underlying asset. Absent for abstract concepts.tags— short strings for categorization.timestamp— ISO 8601 date-time of the last meaningful change.
Example
Section titled “Example”A minimal file that passes against google:okf:0.1:
---type: concept---A fuller file using the recommended fields:
---type: concepttitle: Schema resolutiondescription: How docmeta picks a schema set for each file.resource: https://example.com/docs/schema-resolutiontags: [reference, schemas]timestamp: 2026-06-25T12:00:00Z---Specification
Section titled “Specification”google:okf:0.1 encodes the Open Knowledge Format v0.1 frontmatter contract.
See the
OKF specification
for the full standard.