diff --git a/README.md b/README.md index cde311f8..e5b02d5a 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@ # zyplayer-doc #### 项目介绍 -定位为所有文档的管理项目，swagger文档、dubbo文档、数据库文档....等，提供一整套的解决方案，为开发者服务，欢迎有想法的一起来写，给个Star鼓励下呗！（您的一个Star是快速迭代的动力源泉！） +定位为所有文档的管理项目，swagger文档、dubbo文档、数据库文档、wiki文档....等，提供一整套的解决方案，为开发者服务，欢迎有想法的一起来写，给个Star鼓励下呗！（您的一个Star是快速迭代的动力源泉！） 欢迎加群讨论，QQ群号：466363173 体验地址：[http://doc.zyplayer.com](http://doc.zyplayer.com/zyplayer-doc-manage/) 需登录 账号：zyplayer 密码：123456 （未运行dubbo服务，不能体验dubbo文档调试） -开放文档地址：[http://doc.zyplayer.com/zyplayer-doc-manage/open-wiki.html?pageId=1&space=23f3f59a60824d21af9f7c3bbc9bc3cb](http://doc.zyplayer.com/zyplayer-doc-manage/open-wiki.html?pageId=1&space=23f3f59a60824d21af9f7c3bbc9bc3cb) （无需登录） +各模块的详细使用文档地址，部署必看： + +[http://doc.zyplayer.com/zyplayer-doc-manage/open-wiki.html?pageId=1&space=23f3f59a60824d21af9f7c3bbc9bc3cb](http://doc.zyplayer.com/zyplayer-doc-manage/open-wiki.html?pageId=1&space=23f3f59a60824d21af9f7c3bbc9bc3cb) #### 软件架构 ##### 一、zyplayer-doc-core 一些核心、公用的类 @@ -19,7 +21,7 @@ > 已集成三套优秀swagger文档前端：[zyplayer-doc-swagger](https://gitee.com/zyplayer/zyplayer-doc)、[swagger-bootstrap-ui](https://gitee.com/xiaoym/swagger-bootstrap-ui)、[springfox-swagger-ui](https://github.com/springfox/springfox/tree/master/springfox-swagger-ui) -> 已集成[zyplayer-doc-db](https://gitee.com/zyplayer/zyplayer-doc)数据库文档 +> 已集成本项目内的各子模块，可直接使用 ##### 四、zyplayer-doc-swagger 原[swagger-mg-ui](https://gitee.com/zyplayer/swagger-mg-ui)，swagger的UI及整套解决方案 > 具有 后端存储、代理请求、模拟返回、所有文档管理 等一系列原创功能，不止UI @@ -42,7 +44,7 @@ 2. 修改zyplayer-doc-manage项目的application.yml配置文件里面的数据库账号密码 3. 启动zyplayer-doc-manage项目，访问地址： -http://127.0.0.1:8082/zyplayer-doc-manage/static/manage/home.html +http://127.0.0.1:8083/zyplayer-doc-manage/ 未登录会进入登录页面，登陆后自动跳回，默认账号：zyplayer 密码:123456 > 注意！！项目页面全是静态的html，如果使用idea启动，有可能访问不了静态页面，需要在这里配置下工作目录，然后重新启动即可 ![](https://images.gitee.com/uploads/images/2019/0127/222951_4ce343fe_596905.png "配置工作目录") diff --git a/zyplayer-doc-core/README.md b/zyplayer-doc-core/README.md new file mode 100644 index 00000000..5b011c42 --- /dev/null +++ b/zyplayer-doc-core/README.md @@ -0,0 +1,9 @@ +# zyplayer-doc-core + +#### 项目介绍 +整个项目的公用模块 + +模块的详细使用文档地址，部署必看： + +http://doc.zyplayer.com/zyplayer-doc-manage/open-wiki.html?pageId=1&space=23f3f59a60824d21af9f7c3bbc9bc3cb + diff --git a/zyplayer-doc-data/README.md b/zyplayer-doc-data/README.md new file mode 100644 index 00000000..fa0f6c29 --- /dev/null +++ b/zyplayer-doc-data/README.md @@ -0,0 +1,9 @@ +# zyplayer-doc-data + +#### 项目介绍 +整个项目的数据核心，操作数据库、登录拦截、权限拦截等 + +模块的详细使用文档地址，部署必看： + +http://doc.zyplayer.com/zyplayer-doc-manage/open-wiki.html?pageId=1&space=23f3f59a60824d21af9f7c3bbc9bc3cb + diff --git a/zyplayer-doc-dubbo/README.md b/zyplayer-doc-dubbo/README.md index 4f1188b8..d6f4f6b5 100644 --- a/zyplayer-doc-dubbo/README.md +++ b/zyplayer-doc-dubbo/README.md @@ -21,10 +21,3 @@ dubbo文档的管理项目，支持文档自动扫描，文档展示和修改， 6. 数组或List参数，调试参数录入格式例：[1,2] ，后端通过JSON工具转成指定类型，有不支持的类型时欢迎反馈 -#### 参与贡献 - -1. Fork 本项目 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request - diff --git a/zyplayer-doc-grpc/README.md b/zyplayer-doc-grpc/README.md new file mode 100644 index 00000000..5453857f --- /dev/null +++ b/zyplayer-doc-grpc/README.md @@ -0,0 +1,9 @@ +# zyplayer-doc-grpc + +#### 项目介绍 +grpc文档 + +模块的详细使用文档地址，部署必看： + +http://doc.zyplayer.com/zyplayer-doc-manage/open-wiki.html?pageId=28&space=23f3f59a60824d21af9f7c3bbc9bc3cb + diff --git a/zyplayer-doc-manage/README.md b/zyplayer-doc-manage/README.md index 808be088..41a1061b 100644 --- a/zyplayer-doc-manage/README.md +++ b/zyplayer-doc-manage/README.md @@ -3,35 +3,7 @@ #### 项目介绍 定位为所有文档的管理项目 -#### 软件架构 -软件架构说明 +各模块的详细使用文档地址，部署必看： +http://doc.zyplayer.com/zyplayer-doc-manage/open-wiki.html?pageId=31&space=23f3f59a60824d21af9f7c3bbc9bc3cb -#### 安装教程 - -1. xxxx -2. xxxx -3. xxxx - -#### 使用说明 - -1. xxxx -2. xxxx -3. xxxx - -#### 参与贡献 - -1. Fork 本项目 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request - - -#### 码云特技 - -1. 使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md -2. 码云官方博客 [blog.gitee.com](https://blog.gitee.com) -3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解码云上的优秀开源项目 -4. [GVP](https://gitee.com/gvp) 全称是码云最有价值开源项目，是码云综合评定出的优秀开源项目 -5. 码云官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) -6. 码云封面人物是一档用来展示码云会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) \ No newline at end of file diff --git a/zyplayer-doc-page/README.md b/zyplayer-doc-page/README.md new file mode 100644 index 00000000..16bd12c0 --- /dev/null +++ b/zyplayer-doc-page/README.md @@ -0,0 +1,9 @@ +# zyplayer-doc-page + +#### 项目介绍 +用来存页面的，里面只有编译后的页面文件 + +模块的详细使用文档地址，部署必看： + +http://doc.zyplayer.com/zyplayer-doc-manage/open-wiki.html?pageId=28&space=23f3f59a60824d21af9f7c3bbc9bc3cb + diff --git a/zyplayer-doc-page/console-page/README.md b/zyplayer-doc-page/console-page/README.md new file mode 100644 index 00000000..987a62dc --- /dev/null +++ b/zyplayer-doc-page/console-page/README.md @@ -0,0 +1,9 @@ +# console-page + +#### 项目介绍 +用来存管理端页面的，里面只有编译后的页面文件 + +模块的详细使用文档地址，部署必看： + +http://doc.zyplayer.com/zyplayer-doc-manage/open-wiki.html?pageId=28&space=23f3f59a60824d21af9f7c3bbc9bc3cb + diff --git a/zyplayer-doc-ui/README.md b/zyplayer-doc-ui/README.md new file mode 100644 index 00000000..a5867301 --- /dev/null +++ b/zyplayer-doc-ui/README.md @@ -0,0 +1,9 @@ +# zyplayer-doc-ui + +#### 项目介绍 +文档前端，开发使用的目录，编译后需手动放到个项目模块下 + +模块的详细使用文档地址，部署必看： + +http://doc.zyplayer.com/zyplayer-doc-manage/open-wiki.html?pageId=28&space=23f3f59a60824d21af9f7c3bbc9bc3cb + diff --git a/zyplayer-doc-wiki/README.md b/zyplayer-doc-wiki/README.md new file mode 100644 index 00000000..9de31ef3 --- /dev/null +++ b/zyplayer-doc-wiki/README.md @@ -0,0 +1,9 @@ +# zyplayer-doc-wiki + +#### 项目介绍 +WIKI文档模块，定位为企业内部使用的WIKI文档 + +模块的详细使用文档地址，部署必看： + +http://doc.zyplayer.com/zyplayer-doc-manage/open-wiki.html?pageId=25&space=23f3f59a60824d21af9f7c3bbc9bc3cb +