Typemark Documentation

フレーム

スクリーンショット、図、動画を枠線付きのフレームに入れます。下にキャプション、上にヒントを任意で付けられます。

2026年11月19日更新

フレームは画像や動画を角丸の枠線付きボックスで囲み、周囲のテキストから視覚的に区別します。キャプションを追加すると、読者が何を見ているのかを説明できます。

Typemark logo
The Typemark logo, framed
<Frame caption="The Typemark logo, framed">
  <img src="/images/logo.svg" alt="Typemark logo" />
</Frame>

画像はフレームの幅いっぱいに広がります。

ヒント

hint を使うと、フレームの上に短い注記を表示できます。何に注目すればよいかを示すのに便利です。

Screenshots read best at full width.

Typemark logomark
Logomark
<Frame hint="Screenshots read best at full width." caption="Logomark">
  <img src="/images/logomark.svg" alt="Typemark logomark" />
</Frame>

Markdown の画像

フレームでは Markdown の画像記法も使えます。

Typemark logo

Written as a Markdown image
<Frame caption="Written as a Markdown image">
  ![Typemark logo](/images/logo.svg)
</Frame>

画像のパス

/images/logo.svg や images/logo.svg のようなパスは、リポジトリ内のファイルを指します。サイトがサブフォルダーにあり、typemark.json の docs_root でそのフォルダーを指定している場合、パスはそのフォルダーからの相対パスになります。https:// で始まる完全な URL はそのまま使えます。

プロパティ

プロパティ型デフォルト説明
captionstringnoneフレームの下に中央揃えで表示されるテキストです。
hintstringnoneフレームの上に表示される小さなテキストです。

画像や動画はタグの間に配置します。画像には PNG、JPG、GIF、WebP、AVIF、SVG を使えます。動画には MP4、WebM、MOV、M4V を使えます。YouTube、Vimeo、Loom、Wistia のプレーヤーも使えます。詳しくは 動画 を参照してください。

ビジュアルエディター

ビジュアルエディターでは、フレームは読み取り専用のソースとして表示され、変更なしで保存されます。編集するにはソースモードに切り替えてください。