diff --git a/FileModule/README.md b/FileModule/README.md deleted file mode 100644 index b0e0b2f..0000000 --- a/FileModule/README.md +++ /dev/null @@ -1 +0,0 @@ -# FileModule diff --git a/README.md b/README.md index 685b9cb..d1723a0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # ChopperBot项目框架 -👉[项目文档]👈() +👉[项目文档](https://twj666.github.io/ChopperBot-Doc/)👈 +👉[项目文档更新指南](https://github.com/969025903/ChopperBot/tree/master/doc/ReadMe.md)👈 + 👉[更新日志](https://gitee.com/sbg-genius/ChopperBot/blob/master/CHANGELOG.md)👈 diff --git a/doc/ReadMe.md b/doc/ReadMe.md new file mode 100644 index 0000000..87ec6bb --- /dev/null +++ b/doc/ReadMe.md @@ -0,0 +1,21 @@ +关于技术文档的更新 +1. 请用idea打开ChopperBot中的doc文件夹 +2. ![image](https://mynoteimages.oss-cn-hangzhou.aliyuncs.com/20230519015418105.png) +3. 修改docs中对应模块内容 +4. 上线项目 +- 如果github中已经有页面分支了请删除页面分支 `pages` +- 在当前的项目 doc/文件夹下进行 `yarn build` +```cmd + +# 导航到构建输出目录 +cd docs/.vuepress/dist + +git init +git add -A +git commit -m 'deploy' + +# 推到你仓库的的 gh-page 分支 +# 将 / 替换为你的信息 +git push -f git@github.com:twj666/ChopperBot-Doc.git master:pages + +``` diff --git a/doc/docs/.vuepress/public/img/favicon.ico b/doc/docs/.vuepress/public/img/favicon.ico index 796d2d9..6384123 100644 Binary files a/doc/docs/.vuepress/public/img/favicon.ico and b/doc/docs/.vuepress/public/img/favicon.ico differ diff --git a/doc/docs/01.指南/01.快速入门/01.简介.md b/doc/docs/01.指南/01.快速入门/01.简介.md index b8d130a..9f9afac 100644 --- a/doc/docs/01.指南/01.快速入门/01.简介.md +++ b/doc/docs/01.指南/01.快速入门/01.简介.md @@ -32,7 +32,7 @@ ChopperBot 留下每个主播的精彩片段 ## 参与贡献 -欢迎各路大佬一起来参与完善 Assistant捏,我们期待你的 PR! +欢迎各路大佬一起来参与完善 ChopperBot捏,我们期待你的 PR! - 贡献代码:代码地址 [ChopperBot](https://github.com/969025903/ChopperBot) ,欢迎提交 Issue 或者 Pull Requests - 维护文档:文档地址 [ChopperBot-Doc](https://github.com/969025903/ChopperBot-Doc) ,欢迎参与翻译和修订