Docs
Documentation
The OpenPress 1.0 contract — components, sources, CLI, skills. Anything not listed here is internal.
Get started
Quick start
Five-step walk from npx init to a deployed document. One command per step.
Get started
Product boundary
What lives in OpenPress, what doesn't, and which tool to reach for instead.
Features
Themes
The press/theme/ contract — tokens, page surfaces, base/, optional patterns/.
Features
MDX sources
How mdxSource() and the sources export wire content into the engine.
Features
Comment markers
Inline @openpress-comment markers — review flow without an external database.
Features
Workspace config
The Manifest schema — metadata, page geometry, source folders, captions, deploy.
CLI
Commands
Three tiers — lifecycle (init/dev/build), output (pdf/deploy), tools (search/inspect/doctor).
Skills
AI agent integration
Slash-command skills (/create-press, /create-theme, /apply-comments).
Component
Press
The document entry — metadata via props, page tree via children. One per document.
Component
Workspace
Multi-document projects — proposal + pitch deck + social cards sharing brand & data.
Component
Frame
One fixed page surface. Covers, content pages, slides, and social cards are all Frames.
Component
MdxArea
A measurable slot inside a Frame that the engine fills with allocated blocks.
Component
Manuscript helpers
Sections + Toc — optional helpers for long-form section flow.
Hooks
useSource
Read a registered MDX source from inside the Press tree. Throws on unknown ids.
Conventions
- Kind badge + Impl / Plan status pill on every API entry.
- Props tables: name · type · default · description.
- Anything outside the API pages — deep imports, internal helpers — is not covered by 1.0 stability.