Live embeds

A diagram in your READMEthat never goes stale.

Architecture screenshots rot the day the system changes. A live embed is one line of markdown on a permanent URL: edit the diagram once and every copy shows the new version within minutes.

Included on every account · No subscription · View only for readers

Renders inGitHubGitLabNotionConfluence

How it works

Three steps, then it stays correct

Public project, one line of markdown, done. The embed does the maintenance.

01

Make the project public

Open Embed in the canvas top bar and switch on "Anyone with the link". That mints the permanent embed URL. Viewers see the diagram, never the editor.

02

Copy one line

The markdown image for GitHub and GitLab READMEs, the iframe for Notion and docs sites, or the bare image URL. The dialog shows each next to a live preview.

03

Paste it and forget it

Commit it to the README, paste it in Confluence. Edit the diagram later, by hand or through your agent, and every embed updates within minutes.

An embed is not an export.

The URL serves the current diagram, not a saved copy. What your docs show stops drifting from what your system does.

See it live

This one is real

The rendered pane is a live fetch of a public Datadef diagram, served by the same /api/embed endpoint your diagrams get.

What you paste

README.md

## Platform architecture

Identity resolution and activation across our customer touchpoints.

![Customer 360 Platform](https://datadef.io/api/embed/customer-360-platform)

_Diagram stays current. It is embedded from Datadef, not exported._

The highlighted line is the embed. Everything markdown renders takes it: GitHub, GitLab, Notion, Confluence, Obsidian, docs sites.

What readers see

LIVE

Platform architecture

Identity resolution and activation across our customer touchpoints.

Customer 360 Platform, a live Datadef embed rendered from its permanent URL

Diagram stays current. It is embedded from Datadef, not exported.

A first render after an edit can take a few seconds; after that the image is served cached until the next edit.

The whole integration

![Customer 360 Platform](https://datadef.io/api/embed/customer-360-platform)

One line. Swap the slug for your own diagram and paste it anywhere markdown renders.

Honest answers

Who can see an embedded diagram?

Anyone with the link, no sign-in required. Viewing is all the link grants: the embed and the public page are strictly view only, and editing stays with the owner and the people they invite into the project.

Does my project have to be public?

Yes. The embed URL resolves only while the project is shared with "Anyone with the link", which is the switch that mints it. For internal-only docs, keep the project private and share the project link with invited members instead.

What if I make the project private again?

Every embed of it stops resolving, immediately. Making the project private is the kill switch for every copy at once: READMEs, wikis, docs sites.

How fast do edits show up?

Within minutes. The first render after an edit can take a few seconds while the new version is drawn; after that the image is served cached until the next edit.

What happens when my credit balance is empty?

Nothing about the embed changes. Credits meter AI generation only, so the diagram stays editable by hand and every embed of it keeps rendering and keeps updating within minutes of an edit. Nothing is deleted and no URL breaks.

Do I have to pay to embed a diagram?

No. Public sharing and live embeds are included on every account, permanently, with no subscription for individuals. Only AI generation is metered, in credits, and a diagram you drew by hand embeds exactly like a generated one.

Put a live diagram in your docs

Make a project public, copy one line, paste it where your team already reads. Embeds are included on every account, with no subscription.

One line of markdown·Updates within minutes·View only for readers