步骤组件
步骤组件
<Steps> 组件可将顺序内容组织起来,并自动添加编号和锚点链接。可用于教程、操作指南、安装说明,或任何需要按顺序执行的内容。
用法
Markdown
变体
带标题的步骤
为步骤添加标题,便于组织和理清思路。
Markdown
使用 Markdown 标题的步骤
您也可以使用 Markdown 标题来定义步骤,无需 <Step> 组件。直接在 <Steps> 内放置 ## 或 ### 标题,它们将自动转换为带锚点链接的步骤标题。
当设置了 toc={true} 时,每个步骤在目录中的位置与其标题级别相对应——## 标题出现在第 2 层,### 标题出现在第 3 层。
Markdown
嵌套组件的步骤
步骤可以包含丰富的内容,包括提示框、手风琴、代码块和其他组件。
Markdown
属性
<Steps> 属性
toc
是否将步骤包含在目录中。默认为 false。
在 <Steps> 内使用 Markdown 标题 时,标题级别决定步骤在目录层级中的位置。## 表示第 2 层,### 表示第 3 层。
tocDepth
当启用 toc 时,步骤在目录中显示的深度。可选值为 1、2 或 3,默认为 3。
使用 Markdown 标题 时,tocDepth 会根据标题级别自动设置。使用 <Step> 组件时,请手动设置该属性以控制目录中的嵌套层级。
Markdown
<Step> 属性
title
步骤的可选标题
id
步骤的唯一 ID。用于链接和导航。如未指定,将自动生成一个 ID。
className
应用于步骤的额外 CSS 类名