Kirigami
Start here

Documentation

The reference for building a site with Kirigami, and for the four ways to drive it: the VS Code extension, the command line, the MCP server and the JavaScript API.

New to Kirigami? The Getting started path walks you from an empty folder to a deployed site. These pages are the reference: precise and complete, one topic per page, with the full detail the tutorial links back to.

Build a site

  • Writing pages: the PHPDOC header, data files, page types, built-in tags, and registering your own tags and hooks.
  • Configuration: every key of kirigami.yaml.
  • PHP class library: Markdown, YAML, images, caching, SEO and the other classes every page can call.
  • Troubleshooting: what to check first when a build, a preview or an export misbehaves.

Tools

The same engine behind four front doors, plus an app for the people who run the site. Pick the one that fits how you work; they build the same site.

  • CLI: kiri build, serve, export and the rest, from any terminal.
  • VS Code extension: create, build, export and preview from the editor's Command Palette and status bar.
  • MCP server: let an AI assistant build, validate and scaffold a project through the Model Context Protocol.
  • JavaScript API: load a project in your own Node code and call build(), export() or serve().
  • Kiri Studio: prepare a site so its owner can edit and publish it from a desktop app, with no Git.

Extend

For plugin authors, embedders and the curious: how the engine fits together and the packages underneath it.

  • Plugin SDK: hooks, commands, task types and the on-disk cache that plugins share with the engine.
  • Internals: ownership, reload, build and export ordering, the PHP boundary and watching.
  • PHP-WASM runtime: PHP 8.5 in WebAssembly, run directly from Node, with its networking and extensions.
  • Design system: tokens, the dark theme, prose, components and the browser scripts.
  • struct-walker: the YAML and JSON walker behind kirigami.yaml.

Every code block on this site is colored at build time by @kirigami/plugin-highlight: no highlighter reaches your browser.