ZBook基于git的开源知识库管理软件

ZBook基于git的开源知识库管理软件

ZBook是一个为团队设计的完全开源的全栈知识库管理软件。若要访问 ZBook 源代码，请跳转至github.com/zizdlp/zboo…。

功能

ZBook 支持多用户管理，允许不同角色的用户根据其权限进行相应操作。每个用户都可以独立创建或管理自己的仓库、编辑个人信息、查看访问分析，以及关联第三方账号（如 GitHub、GitLab 等）。管理员可以分配不同的权限级别，确保安全访问和管理网站的核心功能。多用户功能设计灵活，适用于个人开发者、团队协作以及大型组织使用，为用户提供了高效的管理体验。

ZBook 支持简洁的 Markdown 仓库渲染，支持多种主题风格，颜色，支持多语言、夜间模式等。与此同时，支持多语言的全文检索。

对比

市场上有很多闭源知识库软件，比如gitbook,helplook等等，这些都需要付费才能使用核心特性。 下面是一个将 ZBook 与 MkDocs 及其他类似平台（如 GitBook 和 Docusaurus）进行对比的表格，帮助你了解各平台的特点和区别：

特性/平台	ZBook	MkDocs	GitBook	Docusaurus
开源	是	是	否（核心功能免费）	是
自托管	是	是	否	是
免费使用	是	是	核心功能免费	是
多用户管理	是	否	是（仅付费用户）	否
权限管理	是	否	是（仅付费用户）	否
支持多语言	是	是	是	是
插件扩展	是	是	是	是
Markdown 支持	是	是	是	是
搜索功能	是	是（内置）	是	是
主题自定义	是	是	否（付费版本有限制）	是
评论系统	是	否	否	否
同步支持	是（手动与自动同步）	是（手动同步）	是（Git 集成）	是（Git 集成）
版本控制	是	是	是	是
集成	GitHub, GitLab, etc.	GitHub, GitLab	GitHub	GitHub, GitLab
社区支持	是，有限	活跃	活跃	活跃
访客数据分析	是	否	否	否
部署复杂度	低	低	低	中等
适用场景	多用户、多权限、自托管	轻量级文档项目	小型团队、个人项目	大型项目，社区驱动

快速开始

欢迎使用 ZBook 文档指南。请按照以下说明学习如何使用 ZBook 部署、更新并强化您的文档。

1. 安装依赖

为了顺利运行 ZBook，您需要安装 Docker 和 Docker Compose。请按照以下步骤进行操作：

• 安装 Docker：Docker 是一个开源的容器化平台，用于构建、运行和管理容器化应用程序。请访问 Docker 官方网站 以获取适用于您操作系统的安装指南。
• 安装 Docker Compose： Docker Compose 是一个工具，用于定义和运行多容器 Docker 应用程序。您可以通过访问 Docker Compose 官方文档 来获取安装说明。

确保安装完成后，您可以通过以下命令验证安装是否成功：

docker --version
docker-compose --version

如果以上命令返回 Docker 和 Docker Compose 的版本信息，说明您已经成功安装了依赖项。

2. 克隆仓库,启动服务

仅需几步便可以启动 ZBook 服务:

• 首先克隆仓库：使用 git clone 命令将 ZBook 仓库克隆到本地。
• 切换目录：通过 cd 命令进入 zbook 目录。
• 启动服务：运行 make compose_pull 命令来拉取 Docker 镜像和启动服务。此命令为节省时间拉取了 DockerHub 上已经构建好的镜像，若需从源代码构建，请执行make compose_build。

git clone  https://github.com/zizdlp/zbook.git
cd zbook
make compose_pull

3. 创建第一个 Markdown 仓库

浏览器打开http://localhost:3000网页，首先需要注册一个管理员账户，然后登录（本地测试设置参数关闭邮箱验证选项）。

登录之后将会跳转至个人主页，查看侧边栏，点击新建仓库将会弹出一个表格。我们填入仓库名称、风格等，选择使用https://github.com/zizdlp/zbook-docs这个 markdown 仓库，完成后点击提交，等待仓库创建。

完成

恭喜你！你已经成功设置了 ZBook 文档，效果非常棒！需要支持或想提供反馈？你可以加入我们的社区，或通过电子邮件联系我们： zizdlp@gmail.com。