Skip to content

Latest commit

 

History

History
86 lines (58 loc) · 2.06 KB

README.md

File metadata and controls

86 lines (58 loc) · 2.06 KB

Rhyheart

drea-open-docs

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

license release

项目介绍

本文档项目服务于梦幻社区,对应文档站点为 https://docs.drea.cc,文档内容或有欠缺,诚邀各位开发者们共同参与编写补充。

云端修改

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

本地修改

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

  • 安装开发工具

安装 VSCode、NodeJS、Git

  • 初始化项目

克隆代码

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

进入项目

cd /drea-open-docs

安装yarn

npm install -g yarn

初始化依赖

yarn
  • 调试项目
yarn dev
  • 文档结构
docs
├── .vuepress/    # Vuepress相关文件
│   └── config.ts # 文档配置
├── start/        # 平台介绍
├── forum/        # 社区介绍
├── framework/    # 框架教程
├── app/          # 应用教程
└── README.md     # 首页文档
  • 提交代码

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