Markdown 扩展功能

4 min

本文介绍 Retypeset 主题支持的 Markdown 扩展功能,包括语法示例与效果展示。

图注

使用标准的 Markdown 图像语法 ![alt](src),即可自动生成图注。在 alt 前添加下划线 _ 或留空 alt,即可隐藏图注。

语法

![图片描述](./full/or/relative/path/of/image)

![_图片描述](./full/or/relative/path/of/image)

效果

图片描述
图片描述

_图片描述

Github 仓库卡片

使用双冒号语法 ::github{repo="owner/repo"},即可创建 Github 仓库卡片。在页面加载后,从 GitHub API 中获取仓库数据。

语法

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

效果

radishzzzastro-theme-retypeset

Loading repository data...

-- -- --

提示块

使用 GitHub 语法 > [!TYPE] 或三冒号语法 :::type,即可创建提示块。支持 notetipimportantwarningcaution 五种类型。

语法

> [!NOTE]
> 基础的信息内容。

:::note
基础的信息内容。
:::

:::note[自定义标题]
自定义标题的提示块。
:::

效果

NOTE

基础的信息内容。

TIP

实用的提示建议。

IMPORTANT

重要的通知提醒。

WARNING

紧急的事项说明。

CAUTION

严重的风险警告。

自定义标题

自定义标题的提示块。