An Obsidian plugin that validates and enforces the Open Knowledge Format (OKF) v0.1 across your vault — keeping every note self-describing, agent-readable, and portable.

OKF is an open, minimal convention for representing knowledge as a directory of Markdown files with YAML frontmatter. Its one hard rule: every non-reserved note carries a parseable frontmatter block with a non-empty type. This plugin makes following that effortless. See the OKF specification.

• Conformance validation. Checks every note against OKF v0.1. Spec §9 rules (parseable frontmatter, non-empty type, valid index.md/log.md structure) are reported as errors; the spec's recommended fields and SHOULD-guidance are warnings you can toggle. The spec's permissive rules are respected — broken links and missing optional fields never fail a bundle.
• Vault-wide report. A compact, collapsible side panel lists every non-conformant note, errors first, with a one-line summary of conformant / error / warning counts. Hidden by default; opens only on demand.
• Status-bar indicator. A single status-bar item shows the active note's state (✓ / ⚠ / ✖) with details in its tooltip. Click it to auto-fix the current note.
• Auto-fix. Inserts missing frontmatter (type, title, timestamp) non-destructively — it never overwrites values you've set.
• Prompt for required fields. When a note is missing a meaningful type, a dialog lets you set type, title, and description directly.
• On-save & on-create hooks. New notes, edited notes, and notes added by the Importer plugin are brought into conformance automatically.
• index.md generation. Builds and refreshes OKF §6 directory listings so each folder is self-describing.
• log.md entries. Adds dated §7 changelog entries.
• Portent layer (opt-in, beta). Optionally layer the Portent knowledge-base spec on top of OKF — type vocabulary, lifecycle, and belongs_to/related_to relationships — surfaced as non-blocking warnings. The schema is fully free-form: rename fields (e.g. status → state), redefine the accepted vocabularies, and toggle each check independently, so you can match your own conventions or track the evolving pre-1.0 spec.
• Large-vault friendly. Scans and fixes run through a batched, non-blocking queue with an inline progress bar — the UI never freezes.

Open the command palette and search for OKF:

Clicking the status-bar item auto-fixes the active note and, if a required field is still missing, prompts you to fill it.

Configure under Settings → OKF Enforcer:

• Default type for auto-fix — value inserted into type when fixing notes that lack it.
• Live check on save / open, Scan vault on startup, Fix format issues on save, Auto-generate index.md — automation toggles.
• Batch size — files processed per async chunk (lower = smoother UI on very large vaults).
• Warn on missing recommended fields / tags, Check reserved files — which warnings to surface.
• Excluded folders — paths skipped during validation (default: Templates). The Obsidian config folder (e.g. .obsidian) is always skipped automatically.
• Enable Portent validation (experimental / beta — the Portent spec is pre-1.0 and may change) — layer the Portent spec on top of OKF: default type vocabulary (Project, Operation, Responsibility, Task, Event, Note, Topic, Person), lifecycle metadata (optional and format-free — a single status/state value, boolean organized/archived, or omitted entirely when organized by default), and relationship shape (belongs_to single wikilink, related_to list of wikilinks). All Portent findings are warnings — they never break OKF conformance.
• Portent schema — with Portent validation enabled, every property name and vocabulary is free-form. Remap each concept onto your vault's own frontmatter keys (e.g. rename the lifecycle field status → state) and set the accepted type and status values, so you can follow your own conventions or a future spec revision without waiting for a plugin update. Leave any field blank to restore its default. Each optional check — type vocabulary, lifecycle, belongs_to, and related_to — can be toggled on or off individually.

Requires Obsidian 1.7.2 or newer.

Once accepted: Settings → Community plugins → Browse, search for "OKF Enforcer", install, and enable.

Download main.js, manifest.json, and styles.css from the latest release into your vault at .obsidian/plugins/okf-enforcer/, then enable the plugin.

npm install
npm run build   # bundles main.ts -> main.js via esbuild

Pushing a version tag (e.g. 0.1.0) triggers the GitHub Actions workflow that builds and attaches main.js, manifest.json, and styles.css to a new release automatically.

See CHANGELOG.md.

Issues and pull requests are welcome. See CONTRIBUTING.md.

Apache-2.0.

Implements the Open Knowledge Format specification by Google Cloud Platform.