Live Image

An image address that follows your work, so a README or doc always shows the latest version.

Applies To

Every liveworkspace app

A live image is a plain image address for a file that follows the file as it changes: the server keeps a picture of it that is redrawn after each save, so wherever you place the address shows the current state of the file. It is the companion to an embed: the embed is interactive, while a live image is a single static picture, which is exactly what you need somewhere an <iframe> is not allowed, like a GitHub README or a Markdown file.

How It Differs from an Embed

Both come from a share link and both stay current, but they suit different homes:

  • An embed is an interactive frame, updating in real time. Best for wikis, Notion, and your own pages.
  • A live image is a static picture served at an address. It does not pan or zoom, but it drops into anywhere that accepts an image, including places that strip iframes. It catches up to your edits on the next load.

Getting a Live Image

Open the Share dialog and create or pick a pass for the file.
Open the pass's Live image menu, beside Embed, and choose the format you need: Copy image URL for the bare link, Copy Markdown for a Markdown image snippet, or Copy HTML for an <img> tag.
Paste it where you want the picture to appear. A README takes the Markdown; a web page takes the HTML or the raw URL.

Editing the file updates the image the next time it loads. Browsers and sites may keep a copy for a few minutes, so a page can show the previous version briefly after an edit.

Scoping the Image to One Tab

By default the image shows the file's first tab. When the file has more than one tab, the Live image menu also shows a Tab dropdown: pick a tab and every copy option (image URL, Markdown, HTML) carries a tab parameter that scopes the image to that tab. A pass scoped to one tab always shows its own tab, so its menu has no Tab dropdown.

When It Is Not Offered

A live image only works for a link that opens without a password. An <img> request cannot supply one, so while the file has a share password, its image address shows nothing and the pass offers no Live image menu. Remove the password to use a live image, or use an embed, which can ask for the password inside its frame.

A live image also stops working when its share link is revoked or expires, so keep the link alive for as long as the image is in use.

Privacy

A live image only exposes what its share link exposes, as a flat picture with no editing actions.

A live image in your project's README keeps the file beside the code and always current, without anyone re-exporting and re-committing a PNG.

Was this article helpful?

Still need help?

Try Troubleshooting, or tell us what you were trying to do.

Contact us