Docs · main · unreleased
stomme documentation
Start with the tutorial. Use the how-to guides to get something done, the reference for an exact name, and the explanations for why.
TutorialYour first sitescaffold a site, add a page in the CMS with the live preview, and build it.How-to guidesGet something done15 guides for a task at hand.ReferenceLook up an exact name10 pages of names, keys and options.ExplanationKnow why3 pages on why it works the way it does.
Pages and content
- Connect the CMS work on the files locally, or sign in on the deployed site.
- Turn on a feature a blog, services, areas, testimonials, an FAQ or documents.
- Add a listing a news feed, a for-sale catalog or a case-study index.
- Translate a site pages in more than one language, with hreflang and a switcher.
- Build docs from a repo a documentation section from Markdown on GitHub.
- Store uploads in R2 CMS uploads straight to a Cloudflare R2 bucket.
- Write pages by hand or with an agent blocks written straight into the files, checked against the site's catalog.
- Use stomme with an AI agent the docs as text, the block catalog as data, and a check the agent runs.
Design and blocks
- Theme a site colours, dark mode, fonts and your own CSS.
- Add a custom block your own block in the renderer, the CMS and the lookbook.
- Extend from an outside directory slots, blocks, collections and routes shared between sites.
Going live
- Deploy a site Netlify, Cloudflare Workers, Vercel, a Node server or a static host.
- Connect the contact form the built-in handler, your own endpoint and the handler contract.
- Generate share images Open Graph cards drawn from each entry's fields.
- Measure visits first-party metrics, Cloudflare Web Analytics and consent-gated tags.
Reference
- Blocks every block and its fields.
- Styles the classes and CSS variables a custom block builds with.
- Site config every key of
site,featuresandlistings. - Content collections every collection, its folder and its fields.
- Commands the site's scripts and the engine's tools.
- Routes every route the integration injects, and what every page carries.
- Environment variables what the server, the build and the CMS generator read.
- Metrics beacons every body the metrics script sends.
- Field kit the types and helpers for a block's catalog entry.
- Package exports every import path the engine publishes.
Explanation
- How stomme fits together the catalog, the renderer, the CMS generator and the preview.
- The block model why pages are typed blocks with fixed fields.
- Static first what prerenders, and the few routes that run on a server.