开发使用手册

项目介绍

本文档使用VuePress搭建；使用 MarkDown 语法编写。

使用说明

文档目录结构

所有文档应都放在docs文件夹下，为更好的管理文档，建议将 API 分类并放在不同的文件夹内：

docs
├── README.md
├── instructions.md
├── manual
│   └── index.md
├── operationapi
│   ├── api1.md
│   └── index.md
└── orderapi
    ├── api1.md
    ├── api2.md
    └── index.md

新增文件或者文件夹需要在docs/.vuepress/config.js中编辑侧边栏导航：

sidebar: {
  "/": [
    "/README.md",
    "/instructions.md",
    {
      text: "订单API",
      prefix: "/orderapi/",
      collapsible: true,
      children: ["", "api1", "api2"],
    },
    {
      text: "运营API",
      prefix: "/operationapi/",
      collapsible: true,
      children: ["", "api1"],
    },
  ],
  "/manual/": [
    {
      text: "",
      prefix: "/manual/",
      children: [""],
    },
  ],
}

注意：如果只关注 api 文档本身，只需要修改/这个对象属性；

本地开发

cd mz-openapi-docs
npm install pnpm -g
pnpm install
pnpm docs:dev

发布

pnpm docs:build

构建产物在docs/.vuepress/dist文件夹中，将dist目录中的文件放到服务器根目录就行，可使用阿里云 OSS 的静态资源部署。