PreactPress
The documentation framework for Preact libraries, APIs, and AI coding agents.
PreactPress
The documentation framework for Preact libraries, APIs, and AI coding agents
Ship library docs with MDX, TypeDoc, live playgrounds, validation, and AI-ready exports — all static, all Preact.
Interactive demo
A small MDX example
Author mostly in Markdown, then drop in Preact components exactly where the page needs interactivity. Use the file tabs above the editor to open the MDX page or the full Counter.tsx source.
import Counter from"./components/Counter.tsx"# Interactive documentation<Counter initial={3} />import { useState } from"preact/hooks"export function Counter({ initial = 0 }: { initial?: number }) { const [count, setCount] = useState(initial); return ( <div style={{ display: "inline-flex", alignItems: "center", gap: "0.5rem" }}> <button type="button" onClick={() => setCount((value) => value - 1)} aria-label="Decrease count" > − </button> <span>{count}</span> <button type="button" onClick={() => setCount((value) => value + 1)} aria-label="Increase count" > + </button> </div> );}export default Counter;Rendered result
Interactive documentation
Three main benefits
Focused on Preact documentation
Preact components in MDX
Bring interactive examples, demos and product-specific widgets into otherwise simple content.
Documentation features included
Navigation, sidebars, local search, outlines, tags, i18n and validation are ready in the docs template.
Static deployment anywhere
Build once and publish the generated files to GitHub Pages, Netlify, Vercel, Cloudflare Pages or any static host.
Reference site
Documentation
The full reference starter used for this public demo — guides, examples, search, and i18n.
- Default docs theme
- Full guide + examples
- English / German locales
pnpm dlx @kamod-ch/preactpress init my-docs --template docs
Technical blog
Blog
Editorial starter with RSS, tags, authors, reading time, and a content-loader home page.
- RSS + sitemap
- Tag + author pages
- Engineering blog theme
pnpm dlx @kamod-ch/preactpress init my-blog --template blog
Library / SDK
Product docs
Product and developer-library documentation with guides, concepts, FAQ, and changelog.
- Indigo SDK branding
- Install panel + version badge
- Edit on GitHub
pnpm dlx @kamod-ch/preactpress init my-product --template product-docs
JS/TS API
API reference
Scannable API pages with MDX components for signatures, parameters, and type definitions.
- Protocol theme
- OpenAPI + SDK MDX helpers
- Deep-link headings
pnpm dlx @kamod-ch/preactpress init my-api --template api-docs
Product + admin
SaaS docs
Landing page plus onboarding, billing, roles, integrations, API, and troubleshooting.
- Light product theme
- Workspace onboarding
- Admin role hints
pnpm dlx @kamod-ch/preactpress init my-saas --template saas-docs
Help center
Knowledge base
Support-focused help center with search-first home, categories, and contact CTAs.
- Search-first home
- Category hubs
- Support contact CTAs
pnpm dlx @kamod-ch/preactpress init my-help --template knowledge-base
Marketing + docs
Product + Docs
A polished marketing landing page paired with a focused documentation area and custom theme.
- Custom Preact theme
- Product landing + docs
- Built-in i18n demo
pnpm dlx @kamod-ch/preactpress init my-site --template hono
Editorial
Magazine
A custom editorial theme for articles, tags, and content-heavy sites with teaser grids.
- Custom magazine theme
- Article teasers + tags
- Content loader home
pnpm dlx @kamod-ch/preactpress init my-mag --template magazine
Quick start
Minimal
The smallest starter: a home page, an about page, and one guide — no custom theme.
- Default docs theme
- Tiny file tree
- Fastest way to try PreactPress
pnpm dlx @kamod-ch/preactpress init my-siteComparison
Pick the documentation tool that matches your stack
Each tool has a clear audience. PreactPress is for teams that want documentation built around Preact and MDX.
| Product | Components | Best for |
|---|---|---|
| PreactPress | Preact + MDX | Preact documentation |
| VitePress | Vue | Vue documentation |
| Docusaurus | React | Large documentation portals |
| Starlight | Astro | Cross-framework content sites |
References
Used in real Kamod projects
PreactPress is not only a starter. It is used across Kamod documentation and open-source projects.