How decaporg/decap-cms works
Decap CMS is a browser-based content management app for editing static-site content stored in Git. A user opens the admin app, authenticates, selects a collection, edits or creates an entry, and saves or publishes it through a configured Git backend. The product also supports editorial workflow, media libraries, configurable editor widgets, localization, and integrations. The map emphasizes these documented capabilities and the principal UI-to-backend stages; unsampled provider and feature wiring is shown only where documentation supports it.
Main entry points: backend.ts Backend adapter · App.js Admin app · Editor.js Entry editor · mediaLibrary.ts Media library
Components 25
Admin application
- Admin app
packages/decap-cms-core/src/components/App/App.js
Content editing
- Collection browser
packages/decap-cms-core/src/components/Collection/Collection.js - Entry editor
packages/decap-cms-core/src/components/Editor/Editor.js - Editor interface
packages/decap-cms-core/src/components/Editor/EditorInterface.js - Editor widgets
packages/decap-cms-core/src/components/EditorWidgets/index.js - Markdown editor
packages/decap-cms-widget-markdown/src/MarkdownPreview.js - Rich-text serializers
packages/decap-cms-widget-richtext/src/serializers/index.js - Editorial workflow
packages/decap-cms-core/src/actions/editorialWorkflow.ts - Media browser
packages/decap-cms-core/src/components/MediaLibrary/MediaLibrary.js
CMS services
- Login actions
packages/decap-cms-core/src/actions/auth.ts - Entry actions
packages/decap-cms-core/src/actions/entries.ts - Backend adapter
packages/decap-cms-core/src/backend.ts - Backend login
packages/decap-cms-core/src/actions/auth.ts - CMS state
packages/decap-cms-core/src/reducers/entries.ts - Media library
packages/decap-cms-core/src/actions/mediaLibrary.ts - Asset references
packages/decap-cms-core/src/valueObjects/AssetProxy.ts - Translations
packages/decap-cms-locales/src/index.js - Integrations
packages/decap-cms-core/src/integrations/index.js
Backend connectors
- Authentication UI
packages/decap-cms-ui-auth/src/PKCEAuthenticationPage.js - GitHub backend
packages/decap-cms-backend-github/src/implementation.tsx - GitLab backend
packages/decap-cms-backend-gitlab/src/implementation.ts - Git Gateway
packages/decap-cms-backend-git-gateway/src/implementation.ts - Other Git backends
packages/decap-cms-backend-bitbucket/src/implementation.ts
Other components
- CMS user
- Git repository
Connections 26
- CMS user → Admin app: opens admin
README.md - Admin app → Authentication UI: prompts login
packages/decap-cms-core/src/components/App/App.js - Admin app → Login actions: submits credentials
packages/decap-cms-core/src/components/App/App.js - Admin app → Collection browser: routes to
packages/decap-cms-core/src/components/App/App.js - Admin app → Entry editor: routes to
packages/decap-cms-core/src/components/App/App.js - Collection browser → Entry actions: dispatches entry actions
packages/decap-cms-core/src/components/Collection/Collection.js - Entry editor → Entry actions: loads and saves
packages/decap-cms-core/src/components/Editor/Editor.js - Entry editor → Editor interface: renders
packages/decap-cms-core/src/components/Editor/Editor.js - Editor interface → Editor widgets: renders fields
- Editor widgets → Markdown editor: resolves widget
- Rich-text serializers → Markdown editor: serializes content
- Entry editor → Editorial workflow: dispatches workflow
packages/decap-cms-core/src/components/Editor/Editor.js - Login actions → Backend adapter: uses backend
packages/decap-cms-core/src/actions/auth.ts - Entry actions → Backend adapter: loads and persists
- Backend adapter → GitHub backend: delegates Git operations
- Backend adapter → GitLab backend: delegates Git operations
- Backend adapter → Git Gateway: delegates Git operations
- Backend adapter → Other Git backends: delegates Git operations
- GitHub backend → Git repository: reads and writes
- Media browser → Media library: manages assets
packages/decap-cms-core/src/components/MediaLibrary/MediaLibrary.js - Media library → Backend adapter: persists media
packages/decap-cms-core/src/actions/mediaLibrary.ts - Media library → Asset references: creates references
packages/decap-cms-core/src/actions/mediaLibrary.ts - Collection browser → CMS state: selects collection state
packages/decap-cms-core/src/components/Collection/Collection.js - Entry editor → CMS state: reads editor state
packages/decap-cms-core/src/components/Editor/Editor.js - Admin app → Translations: displays translations
- Media library → Integrations: checks integration
packages/decap-cms-core/src/actions/mediaLibrary.ts