Embed Block
An embed of another Hypermedia document, block or text range by hm:// link, rendered as content, a card, its comments or a link.

Extends

id
The block's permanent identity inside its document.
inherited
revision
Output only: CID of the last Change that modified this block.
optional · inherited
type
Block type tag, always `Embed`.
Embedoptional
link
The embedded resource — an `hm://` URL, optionally pinned to a version, block or text range.
attributes
Embed settings and parent-layout attributes.
optional
childrenType
How this block lays out its children — a children type such as `Unordered` or `Grid`.
optional
columnCount
Number of columns the children occupy when `childrenType` is `Grid`.
optional
textAlignment
Horizontal alignment of the block's text — a text alignment such as `center`; omitted for the default `left`.
optional
view
How the target renders: its content, a card, its comments or a plain link.
optional

other fields:

An embed block shows another Hypermedia resource in place. link is required and is an hm:// URL. It may pin a version with ?v=, follow the latest with &l, and narrow the target to a block (#id), a block with its children (#id+) or a text range (#id[start:end]); see URLs. The view attribute is an embed view: Content, Card, Comments or Link. A block comment is a comment whose body starts with an Embed of the quoted block. Renderers detect cycles and fall back to a link.

Opening an embed

In desktop and web readers, including mobile web, clicking a document block embed opens its document if needed and scrolls to the referenced block. This also applies to document embeds inside comments. Clicking the same reference again scrolls to the block again, even when the URL has not changed. If the referenced block no longer exists in the latest version, the reader opens the newest version that still contains it, or the version the embed pins.

A document embed without a block reference opens the document if needed. If that document is already open, the reader keeps its current scroll position.

A comment embed opens the target document and its comment thread, then reveals, scrolls to, and highlights the exact comment or reply. Clicking it again repeats the scroll. A comment fragment also retains its pinned comment version and text selection.

If the target is missing after loading, the reader shows “Block not found” or “Comment not found”. It opens the target document if needed and preserves the reading position when that document is already open.

See also

Do you like what you are reading? Subscribe to receive updates.

Unsubscribe anytime