再組版

Markdown 拡張機能

5 min

この記事では、Retypeset テーマがサポートする Markdown 拡張機能について、構文例と効果を紹介します。

図のキャプション

標準の Markdown 画像構文 ![alt](src) を使用すると、自動的に図のキャプションが生成されます。alt テキストの前にアンダースコア _ を追加するか、alt テキストを空にすると、キャプションが非表示になります。

構文

![画像の説明](https://image.example.com/image-01.webp)

![_画像の説明](https://image.example.com/image-01.webp)

効果

画像の説明
画像の説明
_画像の説明

Github リポジトリカード

二重コロン構文 ::github{repo="owner/repo"} を使用すると、Github リポジトリカードを作成できます。ページの読み込み後、GitHub API からリアルタイムでリポジトリデータが取得されます。

構文

::github{repo="radishzzz/astro-theme-retypeset"}

効果

radishzzzastro-theme-retypeset

Loading repository data...

-- -- --

アドモニションブロック

GitHub 構文 > [!TYPE] または三重コロン構文 :::type を使用して、アドモニションブロックを作成できます。note、tip、important、warning、caution の 5 種類がサポートされています。

構文

> [!NOTE]
> 内容を流し読みする場合でも、ユーザーに知ってほしい有益な情報。

> [!TIP]
> タスクをより簡単に完了するために役立つオプション情報。

> [!IMPORTANT]
> ユーザーが成功するために必要な重要な情報。

:::warning
潜在的なリスクがあり、ユーザーの即時の注意を必要とする重要な内容。
:::

:::caution
特定の操作によって生じる可能性のある悪影響について。
:::

:::note[カスタムタイトル]
これはカスタムタイトルの付いた注釈ブロックです。
:::

効果

NOTE

内容を流し読みする場合でも、ユーザーに知ってほしい有益な情報。

TIP

タスクをより簡単に完了するために役立つオプション情報。

IMPORTANT

ユーザーが成功するために必要な重要な情報。

WARNING

潜在的なリスクがあり、ユーザーの即時の注意を必要とする重要な内容。

CAUTION

特定の操作によって生じる可能性のある悪影響について。

カスタムタイトル

これはカスタムタイトルの付いた注釈ブロックです。

動画

YouTube や他の動画プラットフォームから埋め込みコードを取得し、markdown ファイルに貼り付けることで、動画を作成できます。width と height パラメータを保持する必要はありません。

構文

<!-- Youtube -->
<iframe src="https://www.youtube.com/embed/9pP0pIgP2kE?si=Rlk4C4ltaVPHXZ80" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

<!-- Bilibili -->
<iframe src="//player.bilibili.com/player.html?isOutside=true&aid=930327443&bvid=BV1sK4y1Z7KG&cid=329802177&p=1" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true"></iframe>

効果

ガイド