ZBook 官方文档

欢迎来到 ZBook，一个为团队设计的完全开源的全栈知识库管理软件。这个仓库是 ZBook 的官方文档仓库，若要访问 ZBook 源代码，请跳转至https://github.com/zizdlp/zbook。若要访问英文页面，请点击Introduction

快速开始

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

1. 安装依赖

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

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

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

bash

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

2. 克隆仓库,启动服务

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

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

bash

3. 创建第一个 Markdown 仓库

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

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

你也可以使用其他的 markdown 仓库（由 markdown 文档组成），具体配置见功能。不了解支持的 markdown 语法？点击语法。

完成

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