重新編排

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 五種類型。

語法

> [!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>

效果

指南