英文原文正文为项目原始 README（英文），本站后续会翻译为中文，当前仅剔除图片与无关章节并统一排版。

书库

  <br>    <br>  

用于存储和组织信息及文档的平台。BookStack 的详细信息可在官方网站 https://www.bookstackapp.com/ 查到。

• 安装说明
• 文档
• 演示实例
• 截图
• BookStack 博客
• 问题列表
• 社区讨论
• 支持选项

📚 项目定义

BookStack 是一个有自己观点的文档平台，提供愉快而简单的开箱体验。新用户使用平台时，应当觉得操作直观，并且只需具备基本的文字处理技能就能参与创建 BookStack 内容。该平台应为有需求的用户提供高级功能，但这些功能不应干扰核心的简单用户体验。

BookStack 并非设计为可扩展的平台，也不适用于与上述声明不同的目的。

在开发理念方面，BookStack 秉持轻松、开放和积极的态度。我们旨在在提供稳定且易于升级的路径的同时，缓慢而持续地发展平台。

您可以在我们的常见问题页面了解更多关于项目及其起源的信息。

🛠️ 开发与测试

请查看我们的开发文档以获取有关BookStack源代码工作的完整详细信息。

如果您只是想自定义或扩展您自己的BookStack实例，请查看我们的Hacking BookStack文档页面，了解实现此操作而无需更改BookStack源代码的各种选项。

有关BookStack版本控制方案和一般发布流程的详细信息请点击这里。

🌎 翻译

BookStack 中的文本翻译通过 Crowdin 上的 BookStack 项目 管理。一些字符串带有冒号前缀的变量，例如 :userName。请保持这些值不变，因为它们将在运行时被替换。

请使用 Crowdin 贡献翻译，而不是打开拉取请求。工作代码库中的翻译可能已过时，通过代码合并可能导致冲突和同步问题。如果您因为某些原因无法使用 Crowdin，可以随时打开问题讨论替代方案。

如果您希望在 Crowdin 上添加一种新语言，以便您能够提供翻译，请在此处打开一个新问题。

请注意，BookStack 中的翻译会提供给“Crowdin 全球翻译记忆库”，它帮助 BookStack 和其他项目查找翻译。如果您不想参与贡献，甚至手动通过代码提供翻译，也不建议向 BookStack 提供翻译。

🎁 贡献、问题与拉取请求

欢迎随时创建问题以请求新功能或报告错误及问题。创建问题时请务必遵循提供的模板。

欢迎提交拉取请求，但除非只是小的调整，否则最好提前打开拉取请求或为您计划的更改创建一个问题，以讨论它如何融入项目并规划合并。仅因为存在功能请求或已被标记，并不意味着该功能会被接受到核心项目中。

拉取请求应从 development 分支创建，因为完成后它们将被合并回 development。请不要从 release 分支构建或请求合并，因为该分支仅用于发布版本。如果您希望修改 CSS 或 JavaScript 内容，请编辑位于 resources/ 的源文件。public 中的任何 CSS 或 JS 文件都是由这些源文件构建的，因此不应直接编辑。有关进一步的开发指导，请参见上面的 开发与测试 部分。

项目的社区规则，包括提交问题和代码贡献的规则，可以在这里找到。

🔒 安全

有关管理 BookStack 实例的安全信息，可以在此处的文档网站找到。

如果您希望收到新的潜在安全问题通知，您可以注册 BookStack 安全邮件列表。

如果您想报告安全问题，关于如何操作的详细信息可以在此处找到。

♿ 无障碍

我们希望 BookStack 尽可能对更多人保持可访问性。我们努力在可能的情况下至少达到 WCAG 2.1 A 级标准，尽管我们并不会在每次版本发布时严格测试。如果您遇到任何可访问性问题，请随时提交问题。

🖥️ 网站、文档与博客

包含项目文档和博客的网站可以在 bookstack/website 仓库中找到。

⚖️ 许可证

BookStack 的源代码根据 MIT 许可证 提供。

BookStack 使用的库以及随同 BookStack 提供的库均根据各自的许可证和版权提供。我们许多核心依赖项的许可证可以在下面的归属列表中找到，但这并不是 BookStack 中使用的所有项目的完整列表。

👪 归属

为建立和改进 BookStack 而努力工作的重要人物可以在这里看到。提供翻译的出色人物，无论是通过 GitHub、Codeberg 还是通过 Crowdin，都可以在这里看到。

以下是用于构建BookStack的优秀开源项目。注意：这并非所有活跃BookStack实例中会使用的库和项目的详尽列表。

• Laravel - MIT
• TinyMCE - MIT
• Lexical - MIT
• CodeMirror - MIT
• Sortable - MIT
• Google Material 图标 - Apache-2.0
• markdown-it 和 markdown-it-task-lists - MIT 和 ISC
• Dompdf - LGPL v2.1
• KnpLabs/snappy - MIT
• WKHTMLtoPDF - LGPL v3.0
• diagrams.net - 嵌入版本条款 / 源项目 - Apache-2.0
• SAML PHP 工具包 - MIT
• League/CommonMark - BSD-3-Clause
• League/Flysystem - MIT
• League/html-to-markdown - MIT
• League/oauth2-client - MIT
• pragmarx/google2fa - MIT
• Bacon/BaconQrCode - BSD-2-Clause
• phpseclib - MIT
• Clockwork - MIT
• PHPStan & Larastan - MIT 和 MIT
• PHP_CodeSniffer - _BSD 三许可证条款_
• JakeArchibald/IDB-Keyval - Apache-2.0
• HTML Purifier 和 htmlpurifier-html5 - LGPL-2.1 和 MIT

有关通过 NPM 和 composer 包管理器导入和使用的 JavaScript 和 PHP 项目及其许可证的详细分类，请参阅 dev/licensing/js-library-licenses.txt 和 dev/licensing/php-library-licenses.txt 文件。