618 字
3 分钟
Markdown 扩展用法
2024-05-01
2024-11-29

除了标准 Markdown,本站还支持一些更适合博客写作的扩展语法,例如 GitHub 仓库卡片、Bilibili 视频、提示块和折叠文本。

GitHub 仓库卡片#

使用 ::github 可以插入一个 GitHub 仓库卡片。页面加载时会从 GitHub API 读取仓库信息。

Fabrizz
/
MMM-OnSpotify
Waiting for api.github.com...
00K
0K
0K
Waiting...

写法如下:

::github{repo="saicaca/fuwari"}

repo 的格式是 <owner>/<repo>,例如 saicaca/fuwari

Bilibili 视频#

使用 ::bilibili 可以插入一个响应式 Bilibili 播放器。

最常用的是 BV 号写法:

::bilibili{bvid="BV1xx411c7mD"}

如果只有 AV 号和 cid,也可以这样写:

::bilibili{aid="123456" cid="654321"}

多 P 视频可以指定 page,也可以使用别名 p

::bilibili{bvid="BV1xx411c7mD" page="2"}
::bilibili{bvid="BV1xx411c7mD" p="2"}

还可以设置播放器标题、是否自动播放、是否开启弹幕。

::bilibili{bvid="BV1xx411c7mD" title="视频标题" autoplay="0" danmaku="0"}
参数说明
bvidBilibili BV 号,例如 BV1xx411c7mD
aidAV 号,不需要写 av 前缀。使用 aid 时必须同时提供 cid
cid视频分 P 对应的 cid。
page / p分 P 页码,默认是 1
titleiframe 的标题,主要用于可访问性。
autoplay是否自动播放,支持 01falsetrue,默认 0
danmaku是否开启弹幕,支持 01falsetrue,默认 0
TIP

默认关闭自动播放和弹幕,适合文章阅读场景。需要展示弹幕时再手动设为 danmaku="1"

提示块#

提示块适合放补充说明、警告或重要信息。本站支持 notetipimportantwarningcaution 五种类型。

NOTE

这是普通说明,适合放读者快速浏览时也应该注意的信息。

TIP

这是小提示,适合放可选但有帮助的内容。

IMPORTANT

这是重要信息,适合放必须注意的前提或结论。

WARNING

这是警告,适合放可能导致问题的操作。

CAUTION

这是谨慎提示,适合放会带来负面后果的操作。

基础写法如下:

:::note
这是普通说明。
:::
:::tip
这是小提示。
:::

自定义提示块标题#

在类型后面加上 [标题] 就可以覆盖默认标题。

自定义标题

这是一条带自定义标题的 note。

:::note[自定义标题]
这是一条带自定义标题的 note。
:::

GitHub 风格提示块#

也可以使用 GitHub 风格的提示块语法。

TIP

这种写法同样会被转换成提示块。

> [!NOTE]
> 这是一条说明。
> [!TIP]
> 这是一条提示。

Spoiler 折叠文本#

spoiler 适合隐藏剧透、答案或不想直接展示的内容。被隐藏的内容仍然支持基础 Markdown。

这句话里有一段 被隐藏的 Markdown 内容

这句话里有一段 :spoiler[被隐藏的 **Markdown** 内容]。
Markdown 扩展用法
https://achcyano.github.io/posts/markdown-extended/
作者
achcyano
发布于
2024-05-01
许可协议
CC BY-NC-SA 4.0