Typemark Documentation

コールアウト

注意書き、警告、ヒントを色付きのコールアウトブロックで強調表示します。4つのタイプ、任意のタイトル、カスタムアイコンに対応しています。

2026年11月19日更新

コールアウトは、ページの流れから重要な情報を取り出して、読者が見落とさないようにするためのものです。タイプごとに色とアイコンが決まっています。

<Callout type="info">
  Typemark generates a sitemap for your published site. There's nothing to configure.
</Callout>

タイプ

type に info、warning、danger、tip のいずれかを設定します。省略すると info になります。

<Callout type="warning">
  Rotating an API key signs out every client still using the old one.
</Callout>

<Callout type="danger">
  Deleting a workspace removes all of its data. You can't undo it.
</Callout>

<Callout type="tip">
  Type `/` in the visual editor and pick **Callout** to insert one without writing MDX.
</Callout>
タイプ用途
info背景情報、補足、サイドノート
warning読者が注意を怠ると問題が起きる可能性があること
danger破壊的または取り消しできない操作
tipショートカットやベストプラクティス

タイトル

title を追加すると、コールアウトに太字の見出し行が表示されます。

<Callout type="info" title="Rate limits">
  The API allows 100 requests per minute per key. Requests over the limit get a `429` response.
</Callout>

カスタムアイコン

各タイプにはデフォルトのアイコンがあります。icon に Heroicons のアウトライン名を設定すると、アイコンを変更できます。

<Callout type="tip" icon="rocket-launch">
  Your site is live as soon as you create the project.
</Callout>

プロパティ

プロパティ型デフォルト説明
type"info" | "warning" | "danger" | "tip""info"色とデフォルトのアイコンを設定します。
titlestringなしコンテンツの上に表示される太字の見出しです。
iconstringそのタイプのアイコンbolt や rocket-launch などの Heroicons 名です。

受け付けられるその他のタグ

以下のタグ名もコールアウトとして表示されるため、これらを使って書かれたページはそのまま動作します。これらも title と icon を受け付けます。

タグ表示形式
<Note>info
<Info>info
<Tip>tip
<Check>チェックサークルアイコン付きの tip
<Warning>warning
<Danger>danger
<Check>
  Saved from the visual editor, a `<Note>` stays a `<Note>`. Typemark keeps the tag name you wrote.
</Check>

ビジュアルエディタでの操作

コールアウトは、そのまま入力できる色付きブロックとして表示されます。ブロック内のドロップダウンでタイプを変更し、コンテンツの上にあるタイトル欄で見出しを追加できます。