Embed a diagram

Embed a diagram when readers need it beside a README or a design discussion outside ArchDocs.

Embeds are available on every plan. Creating or revoking their public links requires docs:write.

Open the document and select Share document in the toolbar.
Select Public, then Create and copy link if you haven't created a link yet.
Under Embed, choose the snippet for your destination and select its Copy button.
Paste the snippet into the destination's Markdown editor or embed field.

Public document sharing dialog with live embed, image and link snippets and copy controls.

The document itself must be Public and have a public link. Publishing its space alone doesn't make embed snippets available. Embeds are read-only.

Choose a format

Live embed (Notion, Confluence) copies an iframe for a page that accepts embedded content. The iframe fetches the saved document each time it loads, so reload the page to see recent saves. A cached response can still show an earlier version.

Select Dark theme before copying to use a dark iframe. Responsive wraps the iframe so it fills the available width while keeping its proportions. Live preview shows the iframe in the dialog. These controls affect the iframe; they don't change the image or bare-link snippets.

Image (GitHub README, anywhere) copies Markdown for an SVG image linked to the public document. Use it in a destination that accepts Markdown images. The image URL is inside the copied Markdown, so you can also use that URL in an image field.

The URL stays the same when you edit the document, and fetching it renders the saved content. Saving a copy of the image produces a snapshot that won't change with the source.

Link to unfurl (Confluence, Notion paste) copies a bare public link. ArchDocs supplies iframe HTML and a thumbnail through oEmbed; a destination must support ArchDocs links to display that preview. If a link stays plain text, use the iframe or image snippet instead.

Remove an embed's access

Embeds use the document's public links. If you revoke the link an embed uses, or change the document to Organization or Private, ArchDocs stops serving the embed's diagram content and image, and that public link stops working.

A host may keep a cached preview or image after access changes. Revoking a link can't remove an image someone has already downloaded.