dogument

Document-as-code. .dog files are TypeScript template literals that compile into portable blocks and render live — with React and Svelte islands side by side in the same document.

Requires bun >= 1.2.

Quickstart

bunx dogument init my-docs        # scaffold a workspace (guide included)
cd my-docs
bunx dogument islands add react . # provision island frameworks
bunx dogument studio .            # boot the live studio, URL printed on start

Edit a .dog file and the page updates live. Drop a .tsx or .svelte component next to it, interpolate it into the document, and it hydrates as an interactive island.

Commands

| Command | What it does | | :---------------------------------- | :---------------------------------------------------------- | | dogument init [dir] | Scaffold a workspace with a starter document and guide | | dogument studio [dir] | The live authoring server: watch → recompile → render | | dogument islands add <name> [dir] | Add an island framework (react, svelte) | | dogument intent <dir> <verb> … | Write into a live workspace without clobbering open buffers | | dogument mcp | Agent tools over stdio (Model Context Protocol) |

Agents welcome

init scaffolds an AGENTS.md so coding agents know the workspace rules, and dogument mcp exposes append / replace-section / read / status / logs as native tools — agents and humans co-edit the same living document.

License

PolyForm Noncommercial 1.0.0 with a supplemental no-AI/ML-training clause — see LICENSE.md. Personal, noncommercial use with attribution; no commercial use; no use as machine-learning training data.