使用 BookStack 写文档，一个开源的 Confluence 替代品

2023-02-06 09:08:54来源：Linux中国

BookStack 是一个开源的、基于网页的文档系统，它允许你创建一个结构化的知识库供个人、团队或公司使用。BookStack 专注于易用性和设计，以适合具有潜在的混合技术技能的受众。它建立在 PHP 框架 Laravel 之上，使用 MySQL 或 MariaDB 作为数据存储。

(资料图)

在尝试为我的工作场所寻找文档或维基系统后，我构建了 BookStack。Confluence是最符合我要求的选项，但基于用户的定价带了的阻碍。Confluence 的封闭性也对我要构建的文档的寿命提出了质疑。最后，我决定建立自己的平台来满足我的需求。我用 MIT 许可发布它，以回馈我多年来喜爱并从中受益的开源社区。

内容层次和组织选项

为了保持熟悉和直观，BookStack 使用了现实世界的书籍术语来描述其组织结构。文档内容被创建为 “页Page”：

“页” 属于一个特定的 “书Book”。在一本书中，“页” 可以选择性地被分组为 “章节Chapter”。随着文档的增长，你可以使用 “书架Shelve” 来对 “书” 进行分类，如果需要，“书” 可以成为多个书架的一部分。

这种结构是 BookStack 的核心，而且往往是决定 BookStack 是否适合你的使用情况的选择因素。

在这个核心层次上，BookStack 还提供了标签、用户收藏夹和高级搜索功能，以确保内容可被发现。

编写文档

在 BookStack 中编写文档的主要方法是通过使用其所见即所得（WYSIWYG）编辑器，它利用了开源的Tiny项目。这个编辑器提供了一系列的内容格式，包括：

各种标题级别代码块可折叠的块表格图片链接iFrame 嵌入提醒呼出项目符、编号和任务列表绘图（通过与开源diagrams.net的整合）

如果你喜欢Markdown，你可以使用内置的 Markdown 编辑器，它提供实时预览并支持与所见即所得编辑器相同的功能集。如果权限允许，你甚至可以根据你所编辑的页面，在这些编辑器选项之间跳转。

你的数据是如何存储的

如果使用了 Markdown，除了原始的 Markdown 内容外，文档以相对简单的 HTML 格式存储在MySQL 或 MariaDB数据库中。很多设计和开发决定都是为了保持这种 HTML 格式的简单性。它尽可能地使用普通的标准 HTML 元素，以确保原始文档内容保持开放和可移植。

上传的图片、附件和创建的图纸被保存在本地文件系统中，但也可以选择存储在一个与 s3 兼容的数据存储中，比如开源的MinIO。