docmeta

docmeta

Validate the presence and format of document metadata against JSON Schema — built for CI.

docmeta checks the metadata in your documents — Markdown frontmatter and more — against one or more JSON Schemas. It verifies that required fields are present and correctly formatted (a type, an ISO 8601 timestamp, a URI resource); it does not judge prose quality. It ships with the Open Knowledge Format (OKF) schema built in, follows clig.dev conventions, and returns a nonzero exit code (plus optional GitHub annotations) when validation fails.

Install

npm install -g docmeta
# or run it without installing:
npx docmeta validate "**/*.md"

Requires Node.js 24 or later.

Quick start

Point docmeta validate at a file, a directory (walked recursively), or a glob. With no --schema, it validates against the built-in OKF schema.

docmeta validate docs/intro.md

✗ docs/intro.md
    (root)      must have required property 'type'   (line 1)  [google:okf:0.1]
    /timestamp  must match format "date-time"        (line 9)  [google:okf:0.1]

1 file checked, 0 passed, 1 failed, 0 errors

A clean run exits 0; validation failures exit 1; operational errors (no input, unknown schema, parse error) exit 2.

Supported formats

Markdown, MDX, AsciiDoc, reStructuredText, XML, and HTML. Run docmeta schemas to list the built-in schemas and every supported format.

Documentation

Full guides, recipes, and reference live on the documentation site:

https://hawkeyexl.github.io/docmeta/

Track	What it covers
Get started	Install and run your first validation.
Set up validation	Stand up validation for a repo: docmeta.config.yaml, per-folder schema overrides.
Run it in CI	GitHub Actions and other CI recipes, exit codes, and PR annotations.
Define & evolve schemas	Author a schema, wire up resolution, and version it without breaking the build.
Reference	Every CLI flag, config key, the schema-resolution precedence chain, and output formats.

Contributing

Contributions are welcome. See CONTRIBUTING.md for dev setup, the test loop, and how to add support for a new input format.

License

MIT