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

    Apifox Markdown 概述

    什么是 Apifox Markdown?#

    Apifox Markdown 是专为 Apifox 平台设计的 Markdown 格式,结合了 Markdown 的简洁易读和 Apifox 的强大功能,为 API 开发者提供更高效的文档编写与协作体验。

    Apifox Markdown 的特点#

    1.
    简洁明了:Markdown 语法简单,易于学习和使用,使得文档编写更加高效。
    2.
    可读性高:Markdown 文档以纯文本形式呈现,无需复杂的排版和样式,使得文档更加易读。
    3.
    易于转换:Markdown 文档可以轻松地转换为其他格式,如 HTML、PDF 等,方便在不同设备和平台上查看。
    4.
    与 Apifox 平台深度集成:在 Apifox 中,用户可以直接将接口文档导出为 Markdown 格式,同时也可以在平台上直接导入和编辑 Markdown 文件,实现了文档与 API 开发流程的无缝对接。

    如何使用 Apifox Markdown?#

    1
    新建 Markdown
    点击项目左侧边栏的+ icon 或者目录中的... icon 即可新建 Markdown 文件。
    CleanShot 2025-02-21 at 12.06.22@2x.png
    2
    编辑 Markdown
    在新建的 Markdown 文件中,可以按照基本的 Markdown 语法来组织你的文档结构。
    CleanShot 2025-02-21 at 12.13.36@2x.png
    3
    导入 Markdown
    想要将已有的 Markdown 文档导入到 Apifox 中,可以在 “项目设置 -> 导入数据 -> Markdown” 中使用导入功能。
    CleanShot 2025-02-21 at 12.15.12@2x.png
    4
    分享与协作
    你可以复制 “协作链接” 将文档分享给其他团队成员或合作伙伴,实现高效的协作。
    CleanShot 2025-02-21 at 12.17.50@2x.png
    修改于 2025-02-21 06:27:50
    下一页
    标题和文本
    Built with