README

一个用于存储和组织信息和文档的平台。有关 BookStack 的详细信息，请访问官方网站 https://www.bookstackapp.com/。

📚 项目定义

BookStack 是一个具有意见的文档平台，提供简单直观的即装即用体验。新用户应该发现这种体验直观，只需要基本的文字处理技能就可以参与 BookStack 的内容创作。平台应该为需要高级功能的人提供这些功能，但它们不应干扰核心的简单用户体验。

BookStack 不是作为可扩展的平台设计的，用于实现上述声明之外的目的。

关于开发理念，BookStack 采用轻松、开放和积极的方法。毕竟，这是一个由捐赠自己空闲时间的人们开发和维护的免费软件。

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

🌟 项目赞助商

以下是我们青铜、银色和金色项目赞助商。非常感谢这些公司对项目的支持。注意：所列服务未经官方 BookStack 项目测试、审查或以任何方式支持。

项目捐赠详情 - GitHub 赞助页面 - Ko-fi 页面

金牌赞助商

青铜赞助商

🛠️ 开发与测试

有关 BookStack 源代码工作的详细信息，请参阅我们的开发文档。

如果您只是想自定义或扩展自己的 BookStack 实例，请参阅我们的Hacking BookStack 文档页面，了解在不修改 BookStack 源代码的情况下实现此目的的各种选项。

有关 BookStack 的版本控制方案和一般发布流程的详细信息，请在此处找到。

🌎 翻译

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

请使用 Crowdin 来提交翻译，而不是打开一个 pull request。工作代码库中的翻译可能已过时，通过代码合并可能会引起冲突和同步问题。如果由于某些原因您不能使用 Crowdin，请随时打开一个问题来讨论替代方案。

如果您希望向 Crowdin 添加新语言以提供翻译，请在这里打开一个新问题。

请注意，BookStack 中的翻译提供给“Crowdin 全球翻译库”，这有助于 BookStack 和其他项目查找翻译。如果您不希望为此做出贡献，则不建议将翻译提交给 BookStack，即使是手动通过 GitHub 提交。

🎁 贡献、问题与 pull request

请随意创建问题，请求新功能或报告错误和问题。只需在创建问题时遵循提供的模板。

欢迎提交 pull request，但除非是小的调整，否则最好提前打开 pull request 或创建一个问题来讨论您打算做出的更改将如何融入项目，并规划合并。即使存在功能请求或标记，也不意味着该功能会被接受到核心项目中。

pull request 应从 development 分支创建，因为它们完成后将合并回 development 分支。请不要从或请求合并到 release 分支，因为这只是为了发布版本。如果您想修改 CSS 或 JavaScript 内容，请编辑 resources/ 中找到的源文件。任何位于 public 中的 CSS 或 JS 文件都是基于这些源文件构建的，因此不应直接编辑。

项目的行为准则可以在这里找到。

🔒 安全性

管理 BookStack 实例的安全信息可以在这里的文档网站上找到。

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

如果您想报告一个安全问题，有关如何操作的信息可以在这里找到。

♿ 无障碍性

我们希望 BookStack 能够让尽可能多的人使用。我们旨在至少达到 WCAG 2.1 级别 A 标准，尽管我们并不在每个版本中都严格测试这一点。如果您遇到任何无障碍性问题，请随时打开一个问题。

🖥️ 网站、文档与博客

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

⚖️ 许可证

BookStack 源代码在 MIT 许可证下提供。

BookStack 使用的库和包含的库在其自己的许可证和版权下提供。我们许多核心依赖项的许可证可以在下面的归属列表中找到，但这不是 BookStack 中使用的所有项目的详尽列表。

👪 归属

为构建和改进BookStack作出贡献的杰出人士可以在这里看到：点击查看。通过GitHub或Crowdin提供翻译的杰出人士可以在这里看到：点击查看。

以下是构建BookStack使用的杰出开源项目。注意：这不是BookStack实例中所有库和项目的详尽列表。

Laravel - MIT
TinyMCE - MIT
CodeMirror - MIT
Sortable - MIT
Google Material Icons - 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
OneLogin的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 and MIT
PHP_CodeSniffer - BSD 3-Clause
JakeArchibald/IDB-Keyval - Apache-2.0

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

ssddanbrown/

维护者

详细信息