582 字
3 分钟
页面浏览--访问次数--
步骤引导

步骤引导容器 steps 用于编写安装指南、配置教程或操作流程,将原本扁平的有序数字列表渲染为带有连线与徽章的视觉流程图。

语法格式#

使用 ::: steps 容器包裹标准 Markdown 有序列表:

::: steps{title="快速上手三步曲"}
1. **安装环境依赖**
确保本地 Node.js 版本满足 `>= 22.12`,并安装 pnpm 包管理器。
2. **克隆并初始化仓库**
```bash
git clone https://github.com/LyraVoid/Shirone.git
cd Shirone
pnpm install
```
3. **启动本地开发服务器**
运行 `pnpm dev` 并在浏览器中访问 `http://localhost:4321`。
:::

渲染效果:

::: steps{title=“快速上手三步曲”}

  1. 安装环境依赖

    确保本地 Node.js 版本满足 >= 22.12,并安装 pnpm 包管理器。

  2. 克隆并初始化仓库

    Terminal window
    git clone https://github.com/LyraVoid/Shirone.git
    cd Shirone
    pnpm install
  3. 启动本地开发服务器

    运行 pnpm dev 并在浏览器中访问 http://localhost:4321。

:::

方括号标题形式#

标题也支持方括号写法,适合标题中包含标点的情况:

::: steps[发布前检查清单]
1. 运行 `pnpm.cmd astro check`,确认 0 错误
2. 运行 `pnpm.cmd build`,确认无警告
3. 推送内容仓库,等待跨仓构建
:::

渲染效果:

::: steps[发布前检查清单]

  1. 运行 pnpm.cmd astro check,确认 0 错误
  2. 运行 pnpm.cmd build,确认无警告
  3. 推送内容仓库,等待跨仓构建 :::

步骤内部可以放什么#

每一步都是一个完整的 Markdown 上下文,可以自由嵌套段落、代码块、提示容器与图片:

::: steps{title="配置评论系统"}
1. **填写环境变量**
::: warning 注意
变量名区分大小写。
:::
2. **在配置文件中启用**
```yaml title="config/comment.yaml"
enable: true
provider: twikoo
```
:::

渲染效果:

::: steps{title=“配置评论系统”}

  1. 填写环境变量

  2. 在配置文件中启用

    config/comment.yaml
    enable: true
    provider: twikoo

:::

与普通有序列表的区别#

场景推荐写法
有先后依赖的操作流程::: steps 容器
并列的要点罗列普通有序列表 1. 2. 3.
无需顺序的清单无序列表 -

渲染特性#

  • 序号圆圈与竖向引导连线完全由 CSS 伪元素与 Material 3 令牌驱动,语义结构保持为标准的 <ol> 列表。
  • 支持在每个步骤内部自由嵌套段落、代码块、提示容器或图片。

第 14 篇,共 30 篇本文属于系列

步骤引导
https://www.ariels.xyz/posts/markdown-steps/
作者
Ariel
发布于
2026-09-30
许可协议
CC BY-NC-ND 4.0

分享文章

生成精美分享图或复制链接,与更多人分享本文。

继续阅读

沿着主题读

基于共同的标签与分类

换条路线

从其他文章中稳定抽取

评论

正在加载评论...