Skip to main content

<Lucid />

The <Lucid /> component renders a Lucid diagram in your documentation.

Support

The <Lucid /> component is supported in domains, services, all messages and custom documentation.

Usage

  1. Include the <Lucid /> component inside the markdown
    • e.g /events/MyEvent/index.mdx

Basic Example

---
#event frontmatter
---

<Lucid diagramId="e29f42a0-67e2-4f80-b0d7-6922bb7dd9c5" />

Output example in EventCatalog

Example output

Props

NameTypeDefaultRequiredDescription
diagramIdstringYesThe ID of the Lucid diagram to embed. You can find the ID in the URL of the Lucid diagram or by clicking "Share" in Lucid and copying the ID from the URL.