Skip to content
ManabloxManabloxManablox

Manablox

Manablox is a headless CMS: it stores structured content and serves it over an API, and you build the website or app that shows it. Editors work in the admin; developers model the content, configure the instance and write the frontend.

Content types can be defined in a config file or built in the admin at runtime: both feed the same registry, the same storage layer and the same generated API.

Where to start

New to Manablox? Read these in order:

  1. Concepts: the words the rest of the documentation uses.
  2. Getting started: create a project with one command, create the first space and the first page, and read it back from the API.
  3. How content is organised: spaces, content types, blocks, fields, locales and publishing.
  4. Delivering content: GraphQL, REST and the SDK, and which one to pick.
  5. Scaffold a frontend: one command writes a working frontend for a space, in one of four shapes. A Vite + Vue SSR frontend builds the same thing by hand, step by step.

By task

I want to…Read
Run it on my machineCreate a project
Add it to a project of my ownUse it as a dependency
Configure an instanceThe config file, Environment variables
Model contentThe content model, Field types, Content types in code
Use the adminA tour, then the page for each area
Build a frontendScaffold a frontend, Delivering content, The SDK
Show editors a live previewPreview and the visual editor
Add a field type or a pluginExtending
Put it in productionDeployment, Operations
Understand the internalsArchitecture, Data model
Know what you may do with itLicensing

For contributors

Contributing describes the Manablox repositories and how to work on them. Then Architecture, Data model, Testing, the generated references (hooks, error keys, HTTP API) and Licensing. The CMS takes contributions under its CONTRIBUTING.md and CLA.md.

About these pages

These pages are the markdown files under docs/ in the manablox-dev-docs repository, rendered with Astro Starlight. Corrections are welcome; its CONTRIBUTING.md says how. Three pages are generated from the code by pnpm docs:generate, which runs manablox docs generate against every plugin Manablox ships; they say so at the top.