Mini CMS Docs
Clear setup, content, API, and CLI guides for teams using Mini CMS.
Mini CMS works for two kinds of people:
- content editors who manage workspaces, projects, collections, and items in the dashboard
- developers who automate schema changes with
mini-cmsand integrate the public API
Start Here
- Dashboard Guide — Manage content, projects, collections, and API keys
- CLI Guide — Sync schema, generate clients, automate content management
- Content API — Public endpoint for reading published collection items
- Schema API — Protected endpoints for pull/push operations
- Environment Variables — Required configuration for deployment
- Hosting — Deploy to Vercel, Netlify, or other Nitro targets
Recommended Path
- Set the required environment variables in Environment Variables.
- Deploy the app with Hosting.
- Create a workspace, then organize content into projects, collections, and items with Dashboard Guide.
- Generate an API key and connect your local project with CLI Guide.
- Read published content from Content API.
Key Concepts
| Concept | Description |
|---|---|
| Workspace | Top-level organization containing projects (like an org) |
| Project | Groups related collections (like a client site) |
| Collection | Content type with a schema (like "testimonials") |
| Item | Single piece of content in a collection |
| API Key | Used by mini-cms for schema sync (workspace or project scoped) |
Public vs Schema API
- Content API: Read-only, public, cached, returns only published items
- Schema API: Protected, requires API key, used for pull/push and CRUD operations