Typemark Documentation

バッジ、アイコン、ツールチップ

ラベル、本文中のアイコン、ホバー時に短い説明を表示する用語のための小さなインラインコンポーネント。

2026年11月19日更新

これら3つは、単独の行ではなく文の中に配置します。多用すると目立たなくなるため、使用は控えめにしてください。

バッジ

バッジは角丸の小さなラベルで、新機能、ベータ版、特定のバージョンに関連することを示すのに適しています。

このエンドポイントは Beta であり、v3 より前に変更される可能性があります。

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

ラベルのテキストはタグの間に入れます。バッジはすべて、共通のニュートラルなスタイルになります。

アイコン

<Icon> は本文中にアイコンを挿入します。Heroicons のアウトライン名を任意に指定でき、加えて Typemark が Heroicon にマップする rocket、gear、book などの一般的な別名も使えます。

Settings をクリックし、次に Domains を選択します。

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

デフォルトでは、アイコンは周囲のテキストのサイズと色に合わせて表示されます。

プロパティ型デフォルト説明
iconstringnoneHeroicons の名前。Typemark が認識しない名前の場合は何も表示されません。
colorstringテキストの色#E8503A のような16進数の色、または CSS の色名。
sizenumberテキストのサイズピクセル単位のサイズ。

ツールチップ

ツールチップは、文を途切れさせずに用語を説明します。テキストには点線の下線が付き、読者がホバーすると説明が表示されます。

すべてのリクエストには API key が必要です。

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

headline を追加すると、説明の前に短い見出しを付けられます。その場合、ツールチップには「headline: tip」と表示されます。

レスポンスは edge にキャッシュされます。

Responses are cached at the <Tooltip headline="CDN" tip="Content delivery network, servers close to your readers">edge</Tooltip>.
プロパティ型デフォルト説明
tipstringnoneホバー時に表示される説明。
headlinestringnone説明の前に、コロンを挟んで表示されるテキスト。

タグの間のテキストが、下線が付く単語またはフレーズになります。

ビジュアルエディタ内

これらのコンポーネントは、ビジュアルエディタでは編集できないインラインのソースとして表示され、変更せずに保存されます。変更する場合は、ソースモードで編集してください。