用于存储和组织信息和文档的平台。 BookStack 的详细信息可以在官方网站 https://www.bookstackapp.com/ 上找到。
安装说明
文档
演示实例
管理员登录
截图
BookStack 博客
问题列表
不和谐聊天
支持选项
BookStack 是一个固执己见的文档平台,提供令人愉快且简单的开箱即用体验。实例的新用户应该会发现体验直观,并且只需要基本的文字处理技能即可参与在 BookStack 上创建内容。该平台应该为那些需要的人提供先进的强大功能,但它们不应该干扰核心的简单用户体验。
BookStack 并非设计为可扩展平台,用于与上述声明不同的用途。
在发展理念上,BookStack有着轻松、开放、积极的态度。归根结底,这是由人们贡献自己的空闲时间开发和维护的免费软件。
您可以在我们的常见问题解答中了解有关该项目及其起源的更多信息。
下面显示的是我们的铜牌、银牌和金牌项目赞助商。非常感谢这些公司对该项目的支持。注意:所列出的服务未经 BookStack 官方项目以任何方式测试、审查或支持。
项目捐赠详情 - GitHub 赞助商页面 - Ko-fi 页面
请参阅我们的开发文档,了解有关 BookStack 源代码工作的完整详细信息。
如果您只是想自定义或扩展自己的 BookStack 实例,请查看我们的 Hacking BookStack 文档页面,了解有关在不更改 BookStack 源代码的情况下实现此目的的各种选项的详细信息。
有关 BookStack 版本控制方案和一般发布流程的详细信息可以在这里找到。
BookStack 中文本的翻译是通过 Crowdin 上的 BookStack 项目进行管理的。某些字符串具有冒号前缀的变量,例如:userName
。保留这些值不变,因为它们将在运行时被替换。
请使用 Crowdin 贡献翻译,而不是打开拉取请求。工作代码库中的翻译可能已经过时,并且通过代码合并可能会导致冲突和同步问题。如果由于某种原因您无法使用 Crowdin,请随时提出问题来讨论替代选项。
如果您希望在 Crowdin 中添加一种新语言,以便能够提供翻译,请在此处打开一个新问题。
请注意,BookStack 中的翻译会提供给“Crowdin Global Translation Memory”,这有助于 BookStack 和其他项目查找翻译。如果您对此贡献不满意,则不建议向 BookStack 提供翻译,即使是通过 GitHub 手动提供。
请随意创建问题来请求新功能或报告错误和问题。请按照创建问题时给出的模板进行操作。
欢迎拉取请求,但除非是一个小调整,否则最好尽早打开拉取请求或为您的预期更改创建一个问题,以讨论它将如何适应项目并规划合并。仅仅因为功能请求存在或被标记,并不意味着该功能将被接受到核心项目中。
拉取请求应该从development
分支创建,因为一旦完成它们就会合并回development
中。请不要从发布分支构建或请求合并到release
分支,因为这仅适用于发布版本。如果您想要更改 CSS 或 JavaScript 内容,请编辑resources/
中的源文件。 public
中的任何 CSS 或 JS 文件都是从这些源文件构建的,因此不应直接编辑。
该项目的行为准则可以在这里找到。
有关管理 BookStack 实例的安全信息可以在此处的文档站点上找到。
如果您希望收到有关新的潜在安全问题的通知,您可以注册 BookStack 安全邮件列表。
如果您想报告安全问题,可以在此处找到详细信息。
我们希望 BookStack 能够被尽可能多的人访问。我们的目标是尽可能至少达到 WCAG 2.1 A 级标准,尽管我们不会在每个版本上严格测试这一点。如果您遇到任何可访问性问题,请随时提出问题。
包含项目文档和博客的网站可以在 BookStackApp/网站存储库中找到。
BookStack 源代码是根据 MIT 许可证提供的。
BookStack 使用和包含的库是根据其自己的许可证和版权提供的。我们许多核心依赖项的许可证可以在下面的属性列表中找到,但这并不是 BookStack 中使用的所有项目的详尽列表。
在这里可以看到致力于构建和改进 BookStack 的伟大人士。在这里可以看到通过 GitHub 或 Crowdin 提供翻译的优秀人员。
以下是用于帮助构建 BookStack 的优秀开源项目。注意:这并不是活动 BookStack 实例中使用的所有库和项目的详尽列表。
Laravel -麻省理工学院
TinyMCE -麻省理工学院
词汇-麻省理工学院
CodeMirror -麻省理工学院
可排序-麻省理工学院
谷歌材质图标 - Apache-2.0
markdown-it 和 markdown-it-task-lists - MIT 和 ISC
Dompdf - LGPL v2.1
KnpLabs/snappy -麻省理工学院
WKHTMLtoPDF - LGPL v3.0
sketchs.net -嵌入式版本术语/源项目 - Apache-2.0
OneLogin 的 SAML PHP 工具包 - MIT
League/CommonMark - BSD-3 条款
联盟/Flysystem -麻省理工学院
League/html-to-markdown -麻省理工学院
League/oauth2-client -麻省理工学院
pragmarx/google2fa -麻省理工学院
Bacon/BaconQrCode - BSD-2 条款
phpseclib -麻省理工学院
发条-麻省理工学院
PHPStan 和 Larastan -麻省理工学院和麻省理工学院
PHP_CodeSniffer - BSD 3 条款
JakeArchibald/IDB-Keyval - Apache-2.0
有关通过 NPM 和 Composer 包管理器导入和使用的 JavaScript 和 PHP 项目及其许可证的详细分类,请参阅 dev/licensing/js-library-licenses.txt 和 dev/licensing/php-library-licenses。 txt 文件。