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

图片背景

使用Background将图像作为背景。

示例效果#

image
代码:
<Background>
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>

设置图片背景色#

背景颜色:preset1
image
背景颜色:preset2
image
背景颜色:preset3
image
背景颜色:preset4
image
背景颜色:preset5
image
背景颜色:preset6
image
背景颜色:preset7
image
背景颜色:preset8
image
背景颜色:preset9
image
背景颜色:preset10
image
背景颜色:preset11
image
背景颜色:preset12
image
背景颜色:preset13
image
背景颜色:preset14
image
背景颜色:preset15
image
背景颜色:preset16
image
背景颜色:preset17
image
背景颜色:preset18
image
背景颜色:preset19
image
背景颜色:preset20
image
代码:
背景颜色:preset1
<Background bgColor="preset1">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>
背景颜色:preset2
<Background bgColor="preset2">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>
背景颜色:preset3
<Background bgColor="preset3">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>
背景颜色:preset4
<Background bgColor="preset4">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>
背景颜色:preset5
<Background bgColor="preset5">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>
背景颜色:preset6
<Background bgColor="preset6">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>
背景颜色:preset7
<Background bgColor="preset7">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>
背景颜色:preset8
<Background bgColor="preset8">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>
背景颜色:preset9
<Background bgColor="preset9">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>
背景颜色:preset10
<Background bgColor="preset10">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>
背景颜色:preset11
<Background bgColor="preset11">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>
背景颜色:preset12
<Background bgColor="preset12">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>
背景颜色:preset13
<Background bgColor="preset13">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>
背景颜色:preset14
<Background bgColor="preset14">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>
背景颜色:preset15
<Background bgColor="preset15">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>
背景颜色:preset16
<Background bgColor="preset16">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>
背景颜色:preset17
<Background bgColor="preset17">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>
背景颜色:preset18
<Background bgColor="preset18">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>
背景颜色:preset19
<Background bgColor="preset19">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>
背景颜色:preset20
<Background bgColor="preset20">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>

设置图片位置#

image
代码:
<Background position="bottom">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450191/image-preview)
</Background>

设置内容圆角#

image
代码:
<Background radius={14}>
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>

设置图片边框#

image
代码:
<Background borderWidth={1}>
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450191/image-preview)
</Background>

设置图片上下/左右边距#

image
代码:
<Background paddingX={80} paddingX={80}>
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>

设置图片上/下/左/右边距#

image
代码:
<Background paddingTop={40} paddingBottom={40} paddingLeft={20} paddingRight={20}>
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>

设置图片背景渐变方向#

image
代码:
<Background bgDirection={90}>
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>

设置图片背景花纹#

背景花纹:ploka
image
背景花纹:ploka2
image
背景花纹:paper
image
背景花纹:paper2
image
背景花纹:paper3
image
背景花纹:wave
image
背景花纹:electronics
image
背景花纹:stars
image
背景花纹:none
image
代码:
背景花纹:ploka
<Background bgGridOverlay="ploka">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>
背景花纹:ploka2
<Background bgGridOverlay="ploka2">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>
背景花纹:paper
<Background bgGridOverlay="paper">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>
背景花纹:paper2
<Background bgGridOverlay="paper2">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>
背景花纹:paper3
<Background bgGridOverlay="paper3">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>
背景花纹:wave
<Background bgGridOverlay="wave">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>
背景花纹:electronics
<Background bgGridOverlay="electronics">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>
背景花纹:stars
<Background bgGridOverlay="stars">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>
背景花纹:none
<Background bgGridOverlay="none">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>

设置图片背景花纹颜色#

背景花纹颜色:white
image
背景花纹颜色:gray
image
背景花纹颜色:black
image
代码:
背景花纹颜色:white
<Background bgGridOverlay="ploka" bgGridOverlayColor="white">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>
背景花纹颜色:gray
<Background bgGridOverlay="ploka" bgGridOverlayColor="gray">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>
背景花纹颜色:black
<Background bgGridOverlay="ploka" bgGridOverlayColor="black">
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>

设置图片背景圆角#

image
代码:
<Background bgRadius={20}>
  ![image](https://api.apifox.com/api/v1/projects/4444182/resources/450190/image-preview)
</Background>

参数说明#

ImageBackground
position
enum<string> 
图片位置
可选
枚举值:
centertopbottomleftrighttopLefttopRightbottomLeftbottomRight
默认值:
center
radius
number 
内容圆角(px)
可选
borderWidth
number 
图片边框(px)
可选
shadow
enum<string> 
阴影
可选
枚举值:
xsmallsmallmiddlelargexlargenone
默认值:
middle
paddingX
number 
左右边距(px)
可选
paddingY
number 
可选
上下边距(px),默认值为paddingX * 5/7
paddingTop
number 
上边距(px)
可选
paddingBottom
number 
下边距(px)
可选
paddingLeft
number 
左边距(px)
可选
paddingRight
number 
右边距(px)
可选
bgColor
string 
可选
内置:"preset1"、"preset2"、"preset3"、"preset4"... 纯色:"blue"、"#1DA1F2" 渐变:"#1DA1F2, #5BB1F4"、"blue,green"、"blue,red:30%,green" 颜色名直接对应 tailwindcss 的颜色名
bgDirection
number 
背景渐变方向(度)
可选
bgGridOverlay
string 
背景花纹
可选
bgGridOverlayColor
string 
背景花纹颜色
可选
bgRadius
number 
背景圆角(px)
可选
上一页
图片边框
下一页
步骤
Built with