---

Kirigami starter

The default template for Kirigami — kiri create clones it when you don't name a template.

---

PHP page templates compiled to dependency-free static HTML — no PHP install, no server.

Develop

npm install
npx kiri serve      # build, then rebuild on save with a live-reloading local server

npx kiri build does a one-off build; npx kiri export writes a production site into dist/. In VS Code, the recommended Kirigami extension runs the same commands and the dev server from the Command Palette and the status bar.

Layout

kirigami.yaml              # the one config file
src/
  _layouts/header.php      # wraps every page (prepros.before)
  _layouts/footer.php      # wraps every page (prepros.after)
  _layouts/types/page.*.php # title + lead around pages with @type page
  _lib/functions.php       # custom tags / shortcodes / hooks
  _index.php               # → src/index.html
  about/_index.php          # → src/about/index.html
  styles/kirigami.core.scss # Sass entry — partials/_conf.scss holds the theme
  scripts/kirigami.core.js  # esbuild entry
assets/fonts/              # inlined by the Sass font pipeline

Retheme in src/styles/partials/_conf.scss — it @forwards @kirigami/canva/conf, so every design token (palette, dark mode, fonts) is one override away. sitemap.xml and robots.txt are generated from kirigami.baseurl. Pushing to main deploys to GitHub Pages through .github/workflows/page.yml.

MIT