#Markdown 扩展

Ink 支持标准 GFM Markdown，并扩展了以下功能。

#容器

markdown

::: tip
这是一个提示
:::

::: warning
这是一个警告
:::

::: danger
这是一个危险提示
:::

::: info
这是一条信息
:::

::: details[点击展开]
折叠内容
:::

提示

这是一个提示

警告

这是一个警告

危险

这是一个危险提示

信息

这是一条信息

点击展开

这里是折叠的内容，点击上方标题展开。

## 自定义容器标题

markdown

::: tip[小贴士]
自定义标题的提示框
:::

小贴士

自定义标题的提示框

## 徽章

markdown

{% badge text="推荐" type="tip" %}
{% badge text="实验性" type="warning" %}
{% badge text="已废弃" type="danger" %}

稳定 API 推荐和实验性功能实验性

#选项卡

markdown

{% tabs %}
{% tab "npm" %}
npm install ink-docs
{% endtab %}
{% tab "yarn" %}
yarn add ink-docs
{% endtab %}
{% tab "pnpm" %}
pnpm add ink-docs
{% endtab %}
{% endtabs %}

bash

npm install ink-docs

{% endtab %}

bash

yarn add ink-docs

{% endtab %}

#代码块

代码块自动带语言标签和复制按钮（hover 显示）。

const ink = require('ink-docs');
ink.build();

#表格

功能	支持
GFM 表格	✅
自动换行	✅
横向滚动	✅

#CJK 自动空格

中文 English 混排会自动加空格，代码块内不受影响。

#音乐播放器

markdown

{% player src="音频URL" title="歌名" artist="歌手" %}

SoundHelix Song 1

SoundHelix

支持播放/暂停、进度条拖拽、时间显示、循环播放。

#视频播放器

markdown

{% video src="视频URL" caption="说明文字" poster="封面图URL" %}

Big Buck Bunny — 示例视频

支持原生 HTML5 视频控件、自定义说明文字、封面图。

在 GitHub 上编辑此页

最后更新：2026-02-28