RuleCMS Documentation
Learn how to build, manage, and publish content with RuleCMS — from composing pages with drag-and-drop widgets to delivering published content into your own websites and apps.
Getting Started
Sign up, accept the license, provision your org and team, and understand the RuleCMS hierarchy.
Organizations & Teams
Multi-org and multi-team structure, team members, invitations, and request-access workflows.
Projects, Environments & Tokens
Apps, projects, Development/Staging/Production environments, and API tokens for consuming published content.
Widgets
Create, edit, and manage widgets — the composer, management pages, JSON editing, and version compare.
The Composer
Master the editing surface: the component palette, collections, overlay layers, and the Modify Display panel for layout, content, images, and per-device settings.
Collections
Shared collections update live content everywhere; embedded collections travel with each widget version. Learn when to use each and how to combine them.
Publishing
Publish to staging and production, browse full version history, compare releases, republish a previous snapshot as the new active version, or restore any snapshot into your draft.
Widget Edit Links Extension
Install the free Chrome extension to click an R badge on published widgets on your live site and open that widget's RuleCMS editor in one step.
Component Libraries
Bring your own React components into RuleCMS as a team-scoped library your editors can use in the composer.
Media Assets
Upload, organize, and pick team-scoped and global RuleCMS images and videos for use in the composer.
Development Integration
Preview live Development drafts on your site in real time with a dev. token and widget key — no publish step.
Custom Props and Click Handlers
Pass your own props from your app to one component inside a widget — a button's onClick, addressed by the component id the composer shows you.
Mount Your Own Components
Register a React component from your app on RuleCMSWidget so a Custom slot in the composer can render it by name — no RuleCMS redeploy.
HTML Custom Element Embed
Embed a published widget in any HTML page with a script tag and <rulecms-widget> — WordPress, Angular, PHP, and more.
API Reference
Fetch published widgets programmatically with tokens and published keys.