oku | Muhammed Demirbaş

A documentation kit. Pages are written in Markdown and rendered in the browser, and one command builds a searchable site, an llms.txt and a single-file copy of every page.

oku means "read!" in Turkish, and it is a documentation kit. Pages are ordinary Markdown. Charts, tables, diagrams and step flows are typed fences inside that Markdown, and the browser renders them with Custom Elements.

One command builds a multi-page site with search, along with an llms.txt for LLM readers. It also writes a self-contained single-file copy of every page. That copy opens from a mail attachment and follows the OS theme. Mermaid, Prism and the fonts are shipped beside the output instead of being loaded from a CDN.

If you write the pages, you keep writing Markdown. GitHub, Obsidian and VS Code still render the prose, the tables and the Mermaid, and an oku-* fence shows there as readable JSON. oku check runs the schema, structure and presentation rules a reviewer would apply, and the build refuses a page that fails them.

The table reference: the JSON of a table fence on the left, the rendered, sortable table on the right The diagrams reference in the dark theme: a Mermaid fence and the pipeline it renders

I write my reports and design documents with it, and its own documentation is built with it too.