Apifox Markdown 语法
  1. 组件
Apifox Markdown 语法
  • Apifox Markdown 概述
  • 基础语法及功能
    • 标题和文本
    • 列表和表格
    • 图片
    • 视频
    • 代码
    • 图标
    • Tailwind CSS 支持
  • 组件
    • 告示
    • 高亮块
    • 折叠块
    • 折叠组
    • 多列
    • 卡片
    • 卡片组
    • 图片边框
    • 图片背景
    • 步骤
    • 选项卡
    • 提示语
    • 点击复制文字
    • 文字 Hover 提示
    • 容器
    • 文本绘图 - Mermaid
      • 流程图
      • 时序图
      • 类图
      • 状态图
      • 关系图
      • 旅程图
      • 甘特图
      • 饼状图
    • 公式
      • 行内公式
      • 块级公式
  • 其它问题
    • 常用快捷键
  • 最佳实践
    • 打造高颜值产品文档的 10 个技巧
  1. 组件

步骤

使用Step组件来表示一系列的步骤或流程。

示例效果#

1
第一步
这里是第一步的内容
2
第二步
这里是第二步的内容
3
第三步
这里是第三步的内容
代码:
<Steps>
    <Step title="第一步">
        这里是第一步的内容
    </Step>
    <Step title="第二步">
        这里是第二步的内容
    </Step>
    <Step title="第三步">
        这里是第三步的内容
    </Step>
</Steps>
可以添加任意数量步骤。步骤内容遵循 Markdown 语法。

自定义图标#

默认图标是阿拉伯数字。可根据需求设置图标。
第一步
这里是第一步的内容
第二步
这里是第二步的内容
第三步
这里是第三步的内容
代码:
<Steps>
    <Step title="第一步" icon="remix-progress-2-fill">
        这里是第一步的内容
    </Step>
    <Step title="第二步" icon="remix-progress-4-fill">
        这里是第二步的内容
    </Step>
    <Step title="第三步" icon="remix-progress-6-fill">
        这里是第三步的内容
    </Step>
</Steps>

参数说明#

Step
title
string 
定义步骤标题
必需
icon
string 
可选
定义图标。方法查阅图标
上一页
图片背景
下一页
选项卡
Built with