时间线
概述
在 markdown 中，使用 ::: timeline 容器，包含 markdown 无序列表语法，即可实现 时间线 的渲染效果。
- 支持 水平方向 和 垂直方向
- 垂直方向支持 左对齐，右对齐 和 两端对齐
- 支持 图标 和 线条样式
- 支持通过预设 类型 设置 颜色，支持自定义颜色
该功能默认不启用，你需要在 theme 配置中启用。
export default defineUserConfig({
theme: plumeTheme({
markdown: {
timeline: true,
}
})
})语法
在 ::: timeline 容器中，使用 markdown 无序列表语法，列表的每一个项即时间线上的每一个点。
::: timeline 配置
- 标题
配置
正文内容
- 标题
配置
对于列表的每一个项：
从 首行开始 到 首个空行，均为 标题 ，在标题后紧跟随的一行，用于 配置 当前项的行为
首个空行之后: 正文内容
请注意添加正确的缩进
一个简单的例子：
输入：
::: timeline
- 节点一
time=2025-03-20 type=success
正文内容
- 节点二
time=2025-02-21 type=warning
正文内容
- 节点三
time=2025-01-22 type=danger
正文内容
:::输出：
节点一
正文内容
2025-03-20
节点二
正文内容
2025-02-21
节点三
正文内容
2025-01-22
时间线默认为垂直方向
配置
时间线 支持非常灵活且灵活的配置项，配置主要分为两个部分：
容器配置： 在
::: timeline容器上的配置，配置项跟随在::: timeline之后，如：::: timeline horizontal表示渲染为水平方向的时间线。列表项配置： 列表的每一个项的配置，紧跟随在标题之后的一行，如：
::: timeline - 标题 <!--标题行--> 也是标题 <!--标题行--> time=2025-03-20 type=success <!--配置跟随在最后的标题行之后的单独一行，可选--> <!--空行，有正文时必须--> 正文内容 :::
容器配置
渲染为水平方向的时间线
每个时间节点默认渲染为卡片样式（可在列表项配置中覆盖）
时间节点的对齐方式。仅在垂直方向时生效
left: 时间轴左侧对齐right: 时间轴右侧对齐between: 时间轴两端对齐 (通过列表项配置中的placement定义位置，默认为left)
线条样式（可在列表项配置中覆盖）
列表项配置
时间点，可以是任何字符串，比如 2025-03-20， Q1 等。
时间节点的类型。
当前时间节点渲染为卡片样式。默认值从容器配置 card 中继承
线条样式。 默认值从容器配置 line 中继承
时间节点的图标，支持所有的 iconify 图标。
当容器配置 placement 为 between 时，定义当前时间节点的位置。
left: 在时间轴左侧right: 在时间轴右侧
时间节点线条颜色，可以是任何有效的颜色值。
示例
水平方向
在 :::timeline 后跟随声明 horizontal , 即可将时间线渲染为水平方向。
输入：
::: timeline horizontal
- 节点一
time=2025-03-20
正文内容
- 节点二
time=2025-04-20 type=success
正文内容
- 节点三
time=2025-01-22 type=danger
正文内容
- 节点四
time=2025-01-22 type=important
正文内容
:::输出：
节点一
正文内容
2025-03-20
节点二
正文内容
2025-04-20
节点三
正文内容
2025-01-22
节点四
正文内容
2025-01-22
右对齐
在 :::timeline 后跟随声明 placement="right" , 即可将时间线渲染为右对齐。
输入：
::: timeline placement="right"
- 节点一
time=2025-03-20
正文内容
- 节点二
time=2025-04-20 type=success
正文内容
- 节点三
time=2025-01-22 type=danger
正文内容
- 节点四
time=2025-01-22 type=important
正文内容
:::输出：
节点一
正文内容
2025-03-20
节点二
正文内容
2025-04-20
节点三
正文内容
2025-01-22
节点四
正文内容
2025-01-22
两端对齐
在 :::timeline 后跟随声明 placement="between" , 即可将时间线渲染为两端对齐。
列表项默认位于时间线的左侧，可以通过 placement="right" 为列表项设置右侧位置。
输入：
::: timeline placement="between"
- 节点一
time=2025-03-20 placement=right
正文内容
- 节点二
time=2025-04-20 type=success
正文内容
- 节点三
time=2025-01-22 type=danger placement=right
正文内容
- 节点四
time=2025-01-22 type=important
正文内容
:::输出：
节点一
正文内容
2025-03-20
节点二
正文内容
2025-04-20
节点三
正文内容
2025-01-22
节点四
正文内容
2025-01-22
节点类型
在列表项配置中，添加 type=节点类型 可以为当前节点设置节点类型。
输入：
::: timeline
- 节点一
time=2025-03-20 type=success
正文内容
- 节点二
time=2025-04-20 type=warning
正文内容
- 节点三
time=2025-01-22 type=danger
正文内容
- 节点四
time=2025-01-22 type=important
正文内容
:::输出：
节点一
正文内容
2025-03-20
节点二
正文内容
2025-04-20
节点三
正文内容
2025-01-22
节点四
正文内容
2025-01-22
线条风格
- 在容器配置中添加
line=线条风格可以为所有节点设置默认线条风格。 - 在列表项配置中，添加
line=线条风格可以为节点设置线条风格。
输入：
::: timeline line="dotted"
- 节点一
time=2025-03-20
正文内容
- 节点二
time=2025-04-20 type=success
正文内容
- 节点三
time=2025-01-22 type=danger line=dashed
正文内容
- 节点四
time=2025-01-22 type=important line=solid
正文内容
:::输出：
节点一
正文内容
2025-03-20
节点二
正文内容
2025-04-20
节点三
正文内容
2025-01-22
节点四
正文内容
2025-01-22
带图标的节点
在列表项配置中，添加 icon=图标名称 可以为节点添加图标。
图标名称支持 iconify 的图标名称。
输入：
::: timeline placement="between"
- 节点一
time=2025-03-20 placement=right icon=mdi:balloon
正文内容
- 节点二
time=2025-04-20 type=success icon=mdi:bookmark
正文内容
- 节点三
time=2025-01-22 type=danger placement=right icon=mdi:bullhorn-variant-outline
正文内容
- 节点四
time=2025-01-22 type=important card=true icon="mdi:cake-variant-outline"
正文内容
:::输出：
节点一
正文内容
2025-03-20
节点二
正文内容
2025-04-20
节点三
正文内容
2025-01-22
节点四
正文内容
2025-01-22
卡片节点
卡片节点可以很灵活的进行控制：
- 在容器配置中添加
card即可使每个列表项都是卡片节点。 - 在列表项配置中，添加
card=true即可为节点设置为卡片节点。 - 在列表项配置中，添加
card=false即可为节点设置为非卡片节点。
卡片节点的样式会受到 type 配置的影响。
在列表项配置中添加 card=true / card=false 可以覆盖容器节点的 card 配置
输入：
::: timeline card
- 节点一
time=2025-03-20
正文内容
- 节点二
time=2025-04-20 type=success card=false
正文内容
- 节点三
time=2025-01-22 type=danger
正文内容
- 节点四
time=2025-01-22 type=important
正文内容
:::输出：
节点一
正文内容
2025-03-20
节点二
正文内容
2025-04-20
节点三
正文内容
2025-01-22
节点四
正文内容
2025-01-22
自定义节点类型
时间轴的节点类型是通过 CSS Variables 控制的，主题提供了以下的 CSS 变量：
:root {
--vp-timeline-c-line: var(--vp-c-border); /* 线条颜色 */
--vp-timeline-c-point: var(--vp-c-border); /* 点颜色 */
--vp-timeline-c-title: var(--vp-c-text-1); /* 标题文本颜色 */
--vp-timeline-c-text: var(--vp-c-text-1); /* 正文文本颜色 */
--vp-timeline-c-time: var(--vp-c-text-3); /* 时间文本颜色 */
--vp-timeline-c-icon: var(--vp-c-bg); /* 图标颜色 */
--vp-timeline-bg-card: var(--vp-c-bg-soft); /* 卡片节点的背景颜色 */
}比如主题内置的节点类型 tip:
.vp-timeline-item.tip {
--vp-timeline-c-line: var(--vp-c-tip-1);
--vp-timeline-c-point: var(--vp-c-tip-1);
--vp-timeline-bg-card: var(--vp-c-tip-soft);
}可以在 自定义样式 中，覆盖内置的类型，或者添加新的类型。
示例：
.vp-timeline-item.your-type {
--vp-timeline-c-line: #3cf;
--vp-timeline-c-point: #3cf;
--vp-timeline-bg-card: rgba(60, 252, 255, 0.314);
}::: timeline
- 节点一
time=2025-03-20
正文内容
- 节点二
time=2025-04-20 type=your-type card=true
正文内容
- 节点三
time=2025-01-22 type=danger
正文内容
:::节点一
正文内容
2025-03-20
节点二
正文内容
2025-04-20
节点三
正文内容
2025-01-22
