Welcome to EventCatalogEditor
A visual GUI editor for EventCatalog documentation stored directly in GitHub.
What is EventCatalogEditor?
EventCatalogEditor is a web-based visual editor designed to simplify the management of your EventCatalog documentation. Instead of manually editing MDX files in a code editor, you can use our intuitive interface to browse, create, and modify architectural artifacts like Domains, Services, Events, Commands, and Queries.
EventCatalogEditor Features
GitHub-first Workflow
- Uses GitHub as the source of documentation, with full version control benefits.
- Open existing EventCatalog projects.
- Create new EventCatalog projects.
Model & Structure
- Edit core entities: Domain, Service, Command, Query, and Event.
- Support for entity hierarchy (e.g., Domain Services).
- Edit custom documentation (excluding custom doc navigation structure).
Editing & Commits
- Markdown rich-text editor with preview capabilities.
- Make quick changes to single entities and docs in a single commit.
- Stage multiple entity/documentation changes and commit all together.
- Preview raw changes to files stored in GitHub during commit.
Who it's for?
It's built for development teams, architects, and technical writers who use EventCatalog to document their distributed systems, microservices, and event-driven architectures.
Frequently Asked Questions
No. EventCatalogEditor uses GitHub as the single source of truth. All files are read and written directly to your GitHub repository in real time.
It follows the standard EventCatalog structure, using MDX files with YAML frontmatter for metadata.