Typemark Documentation

Badges, icons, and tooltips

Small inline components for labels, icons in running text, and terms that need a short explanation on hover.

Updated Nov 19, 2026

These three sit inside a sentence rather than on their own line. Use them sparingly, so they still stand out when they appear.

Badges

A badge is a small pill-shaped label, good for marking something as new, beta, or tied to a version.

This endpoint is Beta and may change before v3.

This endpoint is <Badge>Beta</Badge> and may change before `v3`.

Put the label text between the tags. All badges share one neutral style.

Icons

<Icon> drops an icon into text. It takes any Heroicons outline name, plus common alternative names like rocket, gear, and book that Typemark maps to a Heroicon.

Click Settings, then Domains.

Click <Icon icon="cog-6-tooth" /> **Settings**, then <Icon icon="globe-alt" color="#E8503A" size="18" /> **Domains**.

By default an icon matches the size and colour of the text around it.

PropTypeDefaultDescription
iconstringnoneHeroicons name. A name Typemark doesn't know renders nothing.
colorstringtext colourA hex colour like #E8503A, or a CSS colour name.
sizenumbertext sizeSize in pixels.

Tooltips

A tooltip explains a term without breaking the sentence. The text gets a dotted underline, and the tip shows when readers hover over it.

Every request needs an API key.

Every request needs an <Tooltip tip="A secret string that identifies your account. Find it in your dashboard.">API key</Tooltip>.

Add headline to put a short lead-in before the tip. The tooltip then reads "headline: tip".

Responses are cached at the edge.

Responses are cached at the <Tooltip headline="CDN" tip="Content delivery network, servers close to your readers">edge</Tooltip>.
PropTypeDefaultDescription
tipstringnoneThe explanation shown on hover.
headlinestringnoneText shown before the tip, followed by a colon.

The text between the tags is the word or phrase that gets the underline.

In the visual editor

These components show as non-editable inline source in the visual editor and save back unchanged. To change one, edit it in source mode.