feat(core): add LikeC4 integration for interactive C4 diagrams#2059
feat(core): add LikeC4 integration for interactive C4 diagrams#2059boyney123 wants to merge 1 commit into
Conversation
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
🦋 Changeset detectedLatest commit: c5381b0 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
Hey @boyney123 Seems to me, verify check failed because |
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: c5381b0dc2
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| "@types/shelljs": "^0.8.15", | ||
| "@types/update-notifier": "^6.0.8", | ||
| "@types/uuid": "^10.0.0", | ||
| "likec4": "^1.48.0", |
There was a problem hiding this comment.
Declare likec4 as a runtime dependency
likec4 is imported at runtime in eventcatalog/astro.config.mjs (likec4/vite-plugin), but this commit adds it under devDependencies; consumers installing @eventcatalog/core from npm do not get dev dependencies, so eventcatalog startup/build will fail with module resolution errors before any pages render. Move likec4 (and any directly imported LikeC4 package) into dependencies so published installs can load the config.
Useful? React with 👍 / 👎.
|
Hi @boyney123 , are there still plans to roll out this integration, or has it been shelved? |
|
Global LikeC4 in a single catalog is really great it allows to navigate between components when unfolding a likeC4 diagram. This allows to generate containers / systems using eventcatalog resources. |
|
Just to give this a bump, would love to integrate my likec4 diagrams into EC |
What This PR Does
Adds LikeC4 integration to EventCatalog, enabling users to embed interactive C4 architecture diagrams directly in their documentation. The integration automatically discovers LikeC4 projects and supports multi-project workspaces for isolated diagram namespaces.
Changes Overview
Key Changes
LikeC4ViewMDX component for embedding C4 diagrams in documentationlikec4-project-registryVite plugin that auto-discovers LikeC4 projectslikec4and@likec4/iconsdependenciesHow It Works
1. Creating a LikeC4 Diagram
Users create a diagram by adding two files to any diagram folder:
likec4.config.json- Defines the project name (for multi-project isolation):{ "name": "my-architecture" }architecture.c4- The LikeC4 DSL file defining the architecture:2. Embedding in MDX
Use the
<LikeC4View>component in any MDX file:3. Auto-Discovery
The
likec4-project-registryVite plugin automatically:likec4.config.jsonfiles at build timeThis means users never need to manually register projects - just add the config file and it's automatically available.
4. Multi-Project Workspaces
Each project gets its own isolated namespace, so view names like
indexcan be reused across projects without conflicts. The plugin logs discovered projects at startup:Component Props
viewIdprojectheight"600px"Breaking Changes
None
Additional Notes
.c4files at build time.c4files change in dev mode🤖 Generated with Claude Code