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

图标

目前已支持直接使用以下图标:Material Design Icons (MDI)、Remix Icon、Lucide Icons。

示例效果#

代码:
<Icon icon="material-two-tone-storefront"/>

文本内使用图标#

文字中间插入了一个 图标
文字中间插入了一个 <Icon icon="material-two-tone-storefront"/> 图标

设置图标颜色#

示例效果
代码:
<Icon icon="material-two-tone-storefront" color="blue"/>

设置图标大小#

示例效果
代码:
<Icon icon="material-two-tone-storefront" size={25}/>

组件内使用图标#

折叠块、折叠组、卡片、卡片组、步骤、告示、高亮块等组件都支持使用图标,大多数组件都通过添加参数icon="material-two-tone-storefront"方式使用图标。
示例效果
带图标卡片
这里是卡片内容
代码:
<Card title="带图标卡片" icon="material-two-tone-storefront" > 
这里是卡片内容
</Card>

参数说明#

Icon
icon
string 
必需
icon 支持渲染的名称[iconSetName]-[IconSetVariant]-[IconName] - url,以 http:// 或者 https:// 开头
color
string 
可选
非 url 的图标才生效,支持以下预设颜色会跟随主题变化(pink , blue , purple , cyan , green , magenta , red , orange , yellow , volcano , geekblue , lime , gold , primary)
size
number 
图标的大小
可选
上一页
代码
下一页
Tailwind CSS 支持
Built with