Documentation

Install Stedefast and set up your first site in minutes.

Build and deploy a blog with dynamic comments from scratch — a complete walkthrough.

Build and deploy your first Stedefast site step by step.

Complete reference for stedefast.config.ts options.

Built-in and custom content types in Stedefast.

Front matter fields available in all content types.

How Stedefast processes Markdown content.

Group content into collections and paginate listing pages.

Build page templates with React and TypeScript.

Build page templates with Liquid for simpler pages.

Add client-side interactivity with React islands.

Deploy your Stedefast site to Cloudflare Pages with D1, KV, R2, and Pages Functions.

All stedefast CLI commands and options.

How Stedefast decouples modules from runtime infrastructure using provider interfaces.

Generate templates, layouts, partials, islands, content types, and module islands from the CLI.

Eject a module's island source into your theme for local customisation.

Adapt your Stedefast build for Netlify, Vercel, GitHub Pages, nginx, and Apache.

Audit your built site for broken links, missing alt text, large images, and other quality issues.

Preview your built Stedefast site locally using Cloudflare Wrangler Pages.

Transform standard Markdown footnotes into elegant margin sidenotes on wide screens.

Auto-embed YouTube videos, Twitter/X posts, GitHub Gists, and more via oEmbed at build time.

Add dynamic features to your static Stedefast site with modules.

Add user comments to your site with D1 storage and a moderation queue.

Add clap/like counts to your pages using Cloudflare KV.

Page analytics using Cloudflare Web Analytics — privacy-friendly, no cookies.

Build a custom Stedefast module with static export, worker handler, and React island.

Add a privacy-friendly contact form with Cloudflare Turnstile CAPTCHA, D1 storage, and email delivery.

Add instant full-text search to your Stedefast site with zero server infrastructure.

Add emoji reactions to your pages using Cloudflare KV.

Capture email subscribers with double opt-in confirmation, HMAC-signed tokens, D1 storage, and an admin panel with CSV export.

Extend Stedefast's Markdown pipeline with remark and rehype plugins.

Syntax highlighting for code blocks using Shiki — every VS Code theme, 200+ languages.

Create custom remark and rehype plugins to extend Stedefast's Markdown pipeline.

Generate Open Graph social card images at build time using Satori — one 1200×630 PNG per page, automatically.

Build-time Mermaid diagram rendering — converts fenced mermaid blocks to inline SVG with no client-side JavaScript.

A lightweight reading progress bar that fills as users scroll through your content.

How to contribute plugins, modules, themes, and fixes to the Stedefast monorepo.

Step-by-step guide to writing and submitting a /plugin-* package.

Step-by-step guide to writing and submitting a /module-* package.

TypeScript, Biome, testing, and commit conventions used across the Stedefast monorepo.