okf-gem · graph

okf-gem · the graph

The markdown knowledge graph

A markdown knowledge graph is your project's knowledge kept as a directory of plain markdown files. Each file is one idea. The links you already write between them are the connections. Put together, those files and links form a graph you can open and explore, with no database to run and nothing to declare.

Files are the nodes

Every concept is one markdown file with a little YAML at the top. A file is a node in the graph, so the picture grows as your knowledge does: add a file, add a node. You read and edit them as ordinary markdown, and your agents read the same files from the same place.

The links are the edges

A plain markdown link from one file to another is an edge. You do not declare the graph anywhere; it emerges from the links you write while you document. Good linking is the whole of it, and the shape you get back is an honest map of how your project actually connects.

Explore it live, or ship it static

The same graph comes two ways, and you choose per moment.

Live, with okf server

Boot the graph locally and click through it: nodes colored by type, backlinks, full-text search, an index layer you can toggle on. It reads your files from disk, so an edit shows on the next click.

How the graph server works

Static, with okf render

Bake the whole graph into one self-contained HTML file and host it anywhere static files go: GitHub Pages, an object store, a link you email. No server, no install, a double-click opens it.

How okf render works

Why keep knowledge as a graph

The files your agents read to stay accurate become a page your whole team can browse and search. One source, two audiences, no second copy to keep in sync. When the reasoning behind a decision lives in the graph, it outlives whoever wrote it, and the next session starts from it instead of guessing.

Keep reading