qzleo / dodo-open-docs

DoDo开放平台官方文档

dodo-open-docs

✨ 本文档项目基于 VuePress 框架，以 Markdown 作为编写规范，简单易上手✨

项目介绍

本文档项目服务于DoDo开放平台，对应文档站点为https://open.imdodo.com，文档内容或有欠缺，诚邀各位开发者们共同参与编写补充。

云端修改

对于非专业用户，打开 开放平台文档，找到你想要的编辑的页面，然后点击页面左下角在 GitHub 上编辑此页链接，直接在线编辑，保存后提PR即可！

本地修改

对于专业开发者，可克隆代码到本地进行修改，然后推送到云端

• 安装开发工具

安装 VSCode、NodeJS、Git

• 初始化项目

克隆代码

git clone -b dev https://github.com/dodo-open/dodo-open-docs.git

进入项目

cd /dodo-open-docs

安装yarn

npm install -g yarn

初始化依赖

yarn

• 调试项目

yarn dev

• 文档结构

docs
├── .vuepress/    # Vuepress相关文件
│   └── config.ts # 文档配置
├── go/           # 平台介绍 & 运营规范
├── dev/          # 开发文档
│   ├── start/    # 开发流程
│   ├── api/      # 接口文档
│   ├── event/    # 事件文档
│   └── sdk/      # SDK文档
├── log/          # 开放平台日志
└── README.md     # 首页文档

• 提交代码

确认文档修改无误后即可推送PR到云端，待管理员同步更新到开放平台即可。