247 Star 2.4K Fork 833

dromara / zyplayer-doc

Create your Gitee Account
Explore and code with more than 12 million developers,Free private repositories !:)
Sign up
Clone or Download
contribute
Sync branch
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README
Apache-2.0

zyplayer-doc

专注于私有化部署的在线知识库管理平台

项目简介

zyplayer-doc是一款适合团队和个人私有化部署使用的WIKI文档管理工具,同时还包含数据库管理、Api接口管理等模块。

适合作为公司内部或个人的知识库、笔记、文档管理工具,将文档发布成对外可访问的形式,可作为公司的产品文档、帮助文档等。

体验地址:http://zyplayer.com

在线文档:http://doc.zyplayer.com

欢迎有想法的同学一起来完善,如果觉得不错就给个Star鼓励下呗!作为给项目快速更新的动力!

欢迎加入微信群与我们一起交流

微信群员超过限制只能加好友拉进群,添加微信好友,回复:加群 即可

weixinqun.jpg

快速启动

相关依赖

启动本系统仅依赖JAVA和MySQL

  • JAVA 1.8+
  • MySQL 5.7.x、8.x

数据库安装成功后,需要您手动创建一个库:zyplayer_doc

-- 建库语句
create database zyplayer_doc;

建表SQL脚本无需手动执行,每次启动或更新之后都会检查当前版本,然后自动执行升级SQL脚本,所以每次有版本更新需求只需要下载最新版本启动即可,无需其他特殊操作

Main方法启动

  1. 修改zyplayer-doc-manage/src/main/resources/application.yml配置文件里面的数据库账号密码
  2. 执行com.zyplayer.doc.manage.Application.main方法启动项目

JAR方式启动

  1. 直接下载:直接下载编译好的jar打包文件,编译后的最新版可到 发行版下载处 去下载
  2. 自行编译:也可以自己动手编译,双击执行:zyplayer-doc\build.bat,将使用maven编译整个项目为可执行的jar文件,编译结果文件放在:zyplayer-doc\dist\version文件夹下
  3. 修改第一步或第二步结果文件夹下的application.yml文件里面数据库帐号密码
  4. 双击第一步或第二步结果文件夹下的startup.bat启动项目

Tomcat容器启动

  1. 直接下载编译好的war打包文件,编译后的最新版可到 发行版下载处 去下载
  2. 修改配置文件:zyplayer-doc.zip\apache-tomcat\webapps\zyplayer-doc\WEB-INF\classes\application.yml配置文件里面的数据库账号密码
  3. 双击tomcat\bin\startup.bat启动即可

其他

更多启动方式请参考文档:项目下载与部署

启动后访问:http://127.0.0.1:8083 ,默认登录账号: zyplayer 密码: 123456

各模块介绍

zyplayer-doc-manage 文档管理后台

  1. 具有项目模块导航,人员及权限管理功能,分组管理等功能。
  2. 集成了本项目内的各个子模块功能,是各模块的协调管理模块。

zyplayer-doc-wiki wiki文档工具

  1. 在线管理公司、项目及任意形式的文档
  2. 文档支持按空间划分,按人员分组授权,支持空间收藏和空间内的文档开放访问。
  3. 文档支持编辑、查看、评论、上传附件、历史版本查看、页面权限控制、文档搜索等功能。
  4. 文档编辑支持html富文本方式编辑和markdown的方式编辑。
  5. 本工具使用的开源工具有:vue、element-ui、mavon-editor、wangeditor等。
  6. 参考学习了Atlassian Confluence文档工具进行开发,争取作为该软件的开源免费替代产品,同时作为内部文档管理工具最好的存在。

zyplayer-doc-db 数据库工具

一款在线管理数据库的工具,你可以将所有的数据源统一管理到这里面,团队间的各成员就不必每人在自己电脑上装一个数据库管理软件, 然后再添加数据源,可以统一修改数据库账号密码而不用群广播通知,新员工进入后对他使用到的数据源进行授权即可使用。

  1. 支持MySQL、Doris(MySQL协议)、SQLServer、Oracle、达梦、PostgreSQL、Hive、Impala数据源。
  2. 支持数据库表、字段文档查看修改,表文档导出、建表语句DDL导出、表数据导出。
  3. 支持SQL执行、表数据预览、不同数据库之间的数据互导,支持多数据源管理。
  4. 支持按人员、按数据源对用户授权,可给用户 库表注释查看、注释修改、SQL执行、函数修改等粒度的授权。
  5. 支持库函数和存储过程的增删改查,修改记录查询等。
  6. 目标是取代Navicat,做一个小而精的开源免费的在线数据库管理工具。

zyplayer-doc-api API接口文档管理工具

一款支持统一管理Swagger文档、OpenApi文档、自建接口文档的管理工具,具有文档查看、接口请求、全局参数管理等功能,设计走心,前端代码使用最新技术构建,每一行代码都是全新手动敲出来的,超级简单明了,代码简洁美观可读性好、易维护。

  1. 支持Swagger的文档展示,接口调试,解析速度快,界面设计走心。
  2. 支持将所有的Swagger文档、OpenApi文档、自建接口文档进行统一管理,支持全局参数设置,请求参数缓存,下次自动填充等。
  3. 目标是实现一个平台解决所有项目的接口文档统一管理。

其他

  1. zyplayer-doc-ui 前面各模块的前端UI源码
  2. zyplayer-doc-core 一些核心、公用的类
  3. zyplayer-doc-data 数据库层面的交互
  4. zyplayer-doc-other 一些测试

用爱发电

如果您正在使用这个项目并感觉良好,或者是想支持项目继续开发,您可以通过如下任意方式支持我们:

  1. Star并分享 zyplayer-doc
  2. 保留关于页面的项目链接
  3. 你也可以选择使用 商业版 来支持我们

界面展示

控制台页面 主页面

数据库文档页面 数据库文档

WIKI文档页面 wiki文档

API文档主页面 主页面

API文档查看页面 文档查看页面

API文档在线调试页面 在线调试页面

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: You must give any other recipients of the Work or Derivative Works a copy of this License; and You must cause any modified files to carry prominent notices stating that You changed the files; and You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2018 暮光:城中城 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

About

zyplayer-doc是一款专注于个人与企业私有化部署使用的知识库、WIKI文档管理系统,丰富的功能可满足企业几乎所有的文档管理场景需求。 expand collapse
Cancel

Releases (16)

All

Contributors

All

Activities

Load More
can not load any more
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
Java
1
https://gitee.com/dromara/zyplayer-doc.git
git@gitee.com:dromara/zyplayer-doc.git
dromara
zyplayer-doc
zyplayer-doc
master

Search

344bd9b3 5694891 D2dac590 5694891