Giter VIP home page Giter VIP logo

dodo-open-docs's Introduction

dodo-open

dodo-open-docs

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

license release

项目介绍

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

云端修改

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

本地修改

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

  • 安装开发工具

安装 VSCode、NodeJS、Git

  • 初始化项目

克隆代码

# 如果不行,需要添加代理端口export http_proxy=127.0.0.1:xxxx
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到云端,待管理员同步更新到开放平台即可。

dodo-open-docs's People

Contributors

aiur2002 avatar dodo-open avatar mcchampions avatar rhyheart avatar wthsjy avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

dodo-open-docs's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.