Learn Spillway, one task at a time
Install in five minutes, publish a page, then go deeper: the how-to guides each end with a result you can check, and the reference is generated from the code on every release.
Search the docs
53 results · page 5 of 5
Theming: the Brand area, design tokens, import and export
Every public page carries the site's theme as CSS custom properties on :root. Blocks, modules and custom markup read them, so a brand change reaches every page at once. The admin edits the theme in Brand (Sidebar → Structure → Brand): logos, colors, type, space, block styles and the brand voice,…
Translate a page
Add a second language to the site and publish a Spanish version of a page at /es/<path>, with hreflang alternates and a per-language sitemap.
Types and contract reference
<!-- Generated by pnpm docs:build (docs-reference) from packages/shared/src/index.ts and recurrence.ts. Do not edit by hand; edit the source and run the command. -->
Workstreams
A workstream is a named branch of content changes: many entities, the navigation menus and the site settings edited together, previewed as a whole on a private URL, compared with the live site and merged or discarded in one action, now or on a schedule. Use one for a campaign launch, a redesign, a…
spillwaycms.com: the project website and registry
The project website is built on Spillway itself, hosted through the fleet, and is where people learn the product, read the docs, and publish modules, themes and kits for everyone else. Clean and simple: one site, four jobs.
Browse by section
Getting started
Install with Docker or from source, run the setup wizard, build a first page and install a kit.
How-to guides
Publish a campaign page, connect HubSpot, set up SAML, translate a page, schedule a post and more.
Reference
Content model, blocks, the HTTP API (OpenAPI), the CLI and the roles and permissions, generated from the code.
Operations
Security, enterprise sign-in with OIDC and SAML, and running a fleet of sites.
Development
Architecture, contributing and the roadmap.
Agent guides
Connect Claude Code, Claude Desktop or any MCP client; build a module, a kit or a theme with an agent; the rules agents work under.
How-to guides
Install a kit
A kit installs a site's structure in one step: content types, vocabularies with their terms, collections, forms, menus and starter pages, with optional sample content. Four kits ship with Spillway (higher education, city, intranet portal, nonprofit), plus the docs kit that holds this documentation…
Publish a campaign page
Build a landing page for a campaign in the page builder, run the pre-publish checks, send it through review and publish it at the URL the campaign will use.
Build a page with AI
Turn a one-paragraph brief into a draft page built from real blocks, then make it yours. The AI never publishes: it drafts, you review, an editor publishes.
Schedule a post
Write a blog post now and have it go live at a set time, with the checks still applied at that moment, and optionally come down again later.
Translate a page
Add a second language to the site and publish a Spanish version of a page at /es/<path>, with hreflang alternates and a per-language sitemap.
Launch a campaign with a workstream
Prepare a landing page, the updates to three existing pages and a new menu entry together, show the whole set to stakeholders on one preview link, and publish everything in one action, now or at a scheduled time.
Connect HubSpot to a form
Send every submission of a Spillway form to a HubSpot form, so leads land in the CRM with the page and UTM context, while Spillway keeps its own copy.
Add a department section
Hand a part of the site to a department: its editors manage everything under one path prefix and one menu, and nothing else.
Set up SAML with Okta
Let staff sign in to the admin with their Okta account over SAML 2.0, with accounts created on first sign-in and roles taken from Okta groups.
Import a design system from Figma
Bring the colors (dark mode included), fonts, sizes, spacing, radius and content width of a Figma design system into the site's theme tokens, so every page and block picks them up once you publish.
Import a website
The importer brings an existing site into Spillway from its public pages alone: no database dump, no credentials. It crawls, proposes content types, converts the pages to blocks, extracts the theme and lands everything as drafts with redirects, so the old URLs keep working when you go live.
For AI agents
Agents are first-class readers and builders here. The whole documentation is available as plain text at /llms.txt (an index) and /llms-full.txt (every page), the HTTP API at /openapi.json, and every registry package offers an agent-readable manifest. The agent guides explain how to connect with an API token and what an agent may and may not do: it drafts, a person publishes.
Connect an agent to Spillway
Spillway treats AI agents as first-class readers and builders. An agent connects to a running site with an API token over the MCP server (POST /mcp) or the plain REST API, reads the content model, drafts content, runs the pre-publish checks and hands its work to a person. Every action is…
Rules for agents
What an AI agent working with Spillway must respect, whether it edits content on a site through MCP, writes code in this repository, or publishes a package to the registry. These rules are also encoded in the server: tokens cannot grow permissions, the AI layer has no publish path, and the…
Build a module with an agent
A recipe for having Claude Code, Cursor or any coding agent write a Spillway module: the prompt to paste, what the agent should produce, and the checks to run before you trust it. Read modules.md once yourself; the agent will read it too.
Build a kit with an agent
A kit is a JSON manifest that installs a site's structure: content types, vocabularies with terms, collections, forms, menus, starter pages and sample content. It is the quickest thing to build with an agent, because the format is declarative and the server validates it. Read kits.md first; the…
Build a theme with an agent
A theme in Spillway is a kit of tokens, blocks (shared blocks and page templates built from the core blocks) and page templates, with screenshots, published to the registry with "kind": "theme". Themes do not ship code: the look comes from the theme tokens the server emits as CSS custom…
Publish a package to the registry
How a module, kit or theme reaches the registry on spillwaycms.com (or any Spillway instance running with REGISTRY_HOST=1), from a terminal or from an agent. The registry contract is in packages/shared/src/index.ts under Registry; the operator's side is in modules.md.
Something missing or wrong?
Every page links to its Markdown source. Fix it in a pull request and the next release carries the change.