Embed live model objects, workflows, attachments, and diagrams in specs.
Embeds are what make IOModel specs different from static docs. Instead of pasting screenshots, you reference the live model — objects, workflows, and attachments — so the spec always reflects the current architecture.
In this group
Embed Objects
Render a model diagram, optionally filtered.
Embed Workflow
Show a workflow’s sequence diagram.
Embed Attachments
Embed an ERD, OpenAPI, or MDX attachment.
Embed Mermaid Diagrams
Inline diagrams from text.
Cross-Linking and Navigation
Link pages and anchor to the model.
Why embed instead of paste
| Pasted image | Live embed |
|---|---|
| Goes stale silently | Reflects the current model |
| No navigation | Clickable, navigable |
| Duplicate source of truth | Single source of truth |
Real props matter
Each embed component has a specific prop API. The pages here show the correct usage; the MDX Components reference is the authoritative source.
Last updated on