一、zyplayer-doc

 zyplayer-doc 是一款专注于私有化部署的知识库管理系统,适用于企业与个人,旨在保障数据安全的同时,提供灵活的文档管理和分享功能。系统设计考虑了内外网环境下的高效运作,确保信息的私密性和可控性。
应用场景
企业文档管理: 组织内部知识积累与传播,如政策手册、操作指南、培训材料等。
产品文档发布: 将文档作为产品帮助中心,便于客户查阅。
团队协作: 支持团队成员间的文档共享与协作编辑。
知识分享: 公开文档供外部读者学习,如技术博客、行业洞察等。
核心功能与特色
精细的权限控制: 知识库按空间划分,支持成员可见、企业内公开或互联网公开,确保信息访问的精准控制。
多样化的文档类型: 包括富文本、Markdown、API文档、Office文档、图表等,满足不同场景需求。
文档检索与分析: 强大的全文检索功能,以及文档访问数据的统计分析,辅助优化内容策略。
开放文档分享: 可将文档发布至互联网,支持密码保护、付费阅读等多种访问模式。
协作与编辑: 内置评论、附件管理、历史版本追踪等功能,促进团队协作效率。
版本控制: 手动创建文档版本,便于内容管理和历史回溯。
安全与存储: 支持多种云存储服务,以及严格的安全验证机制,保障数据安全。
部署与集成 zyplayer-doc 提供简便的部署流程,兼容主流服务器环境,支持 Docker 部署,以及通过面板工具快速搭建。系统采用前后端分离架构,易于二次开发与定制。
总结 zyplayer-doc 不仅是一款文档管理工具,更是企业知识管理和内外部沟通的桥梁。无论是内部协作还是对外分享,都能提供专业、安全、高效的解决方案。

二、快速部署

软件的部署比较简单,安装必要的JAVA环境依赖和一个MySQL数据库,去官网下载最新的安装包,然后修改数据库配置后执行 ./startup.sh 即可启动起来,或者使用Docker部署:docker pull zyplayer/zyplayer-doc:latest,也可以使用 1Panel 、宝塔面板NAS 等方式部署,详细的部署方法可在官方文档中查看: https://doc.zyplayer.com

三、功能介绍

1、知识库管理

知识库按空间进行划分,也可对空间进行分组管理,空间可设置为空间成员可见、企业内公开和互联网公开,具有非常细粒度的组织权限划分。

空间内可创建和管理不同类型的文档,如富文本、Markdown、表格、API文档、Office文档、思维导图、本地上传文件等,有友好的文档查看页面和功能丰富的编辑器。

文档以树的形式进行管理,支持无限层级的文档划分组织,任意节点都可包含子文档,可对文档进行收藏置顶展示,支持文档全文检索,以空格分割的多关键字检索等,文档的访问数据具有统计分析功能,每天凌晨自动汇总前一天、周、月的数据,文档删除后可在回收站进行恢复和彻底删除。

分享下最近找到一个好用的个人知识库开源项目_Markdown

编辑

分享下最近找到一个好用的个人知识库开源项目_Markdown_02

编辑

2、公开分享与开放文集

在空间设置页可将编写的文档发布至互联网,发布后获得链接的用户均可访问该空间内的文档,可用于企业产品文档、知识分享等场景使用。

开放文档具有多种展示主题,可设置密码访问、付费阅读、文档试读、动态密码访问等,满足用户绝大部分文档公开分享的场景使用。

分享下最近找到一个好用的个人知识库开源项目_数据_03

编辑

3、丰富的编辑器

具有丰富的文档编辑类型支持,满足绝大部分在线文档编辑、查看、管理的场景,每一种编辑器都经过了长时间的打磨,兼具功能丰富和简洁美观的优点。

其中自研的Markdown编辑器除基础的格式外还支持了VuePress的提示组件、代码块高亮、多页签组件,还有分栏、卡片、名片、时间线、科学公式、Echarts图表、思维导图、流程图、时序图、PlantUML图 等一系列组件,还支持使用Vue编写更多自建组件使用。

Office文档支持Word、PPT、Excel、PDF格式文档的多人在线协同编辑查看,编辑体验和本地编辑器无异。

API文档支持接口文档的在线编辑、调试、公开分享等,作为系统内一种可选的文档类型,让API文档的管理不再独立和分散,基于内网部署也让你的API更加安全,可以更放心的编写内部或对外分享的API接口文档。

分享下最近找到一个好用的个人知识库开源项目_API_04

编辑

4、内部协作支持

在文档右上角操作区包含有各种功能操作按钮,针对单个文档的查看和管理更加方便快捷。

全屏演示功能可在内部投屏讲解时使用,文档更聚焦,文字也做了更大字号的显示。评论功能可对文档整体进行评论、发表意见,附件管理页可上传任意格式的文件,便于相关资源的分享与下载,历史管理页可查看每次保存的文档记录,也可查看或回滚指定的历史记录,便于文档的追溯和还原。

文档的通知包含了所有修改、评论、点赞等操作,让文档所属者及时掌握文档的变化。更多菜单里还包含开放文档的查看、单个文档的分享、页面展示的设置、模板设置、文档下载和文档信息等操作按钮。

分享下最近找到一个好用的个人知识库开源项目_API_05

编辑

5、文档版本控制

在空间设置页可开启版本控制功能,每完成一个版本文档的编写即可手动创建一个版本,各版本内的文档均可独立管理,用户在查看开放文档时也可在右上角切换版本查看对应版本的文档。

分享下最近找到一个好用的个人知识库开源项目_数据_06

编辑

分享下最近找到一个好用的个人知识库开源项目_数据_07

编辑

6、文档存储与安全

系统中图片或附件的存储支持文件系统、阿里云OSS、腾讯云COS、华为云OBS、MinIO、以及支持了Amazon S3协议的存储服务。

系统登录支持文档内置登录、SSO登录接入,可管理控制账号的密码复杂度,登录安全验证支持图形验证码、飞书、钉钉、企业微信的安全校验码,对于员工账号的登录安全做到最可靠的控制。

分享下最近找到一个好用的个人知识库开源项目_API_08

编辑

分享下最近找到一个好用的个人知识库开源项目_Markdown_09

编辑

7、其他功能

支持用户管理、用户权限管理、用户禁用启用等操作,部门以树的形式管理,部门可用于空间添加协作部门使用,可开启用户注册功能,开启后用户可自行在注册页面通过邮箱注册账号使用。

开放文档均支持开启付费阅读,让你的文档能产生实际的收入。

支持文档单页分享、文档导出、整个空间文档的导出、模板管理。

支持文档访问数据统计,有昨日数据、访问趋势分析、页面访问排行、活跃用户排行等一系列统计分析功能。

支持使用Vue编写自建组件,编写的组件可在Markdown文档中直接引用,可添加 iframe 嵌入任意网页,或是公用的广告组件等。

开放文档支持划词反馈,便于用户对于你文档的纠正、反馈和互动。

分享下最近找到一个好用的个人知识库开源项目_Markdown_10

编辑