跳到内容

BookStackApp/BookStack

BookStack(书签堆栈)

GitHub发布 许可证 克劳丁 生成状态 皮棉状态 可维护性

备用来源 回购统计信息 不和谐 乳齿象

PeerTube公司 YouTube网站

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

📚 项目定义

BookStack是一个固执己见的文档平台,它提供了一种愉快而简单的现成体验。实例的新用户应该会觉得体验很直观,只有基本的文字处理技能才能参与到BookStack上的内容创建中。该平台应为那些想要它的用户提供高级功能,但不应干扰核心的简单用户体验。

BookStack不是设计为可扩展平台,用于与上述语句不同的目的。

在发展理念方面,BookStack采用了放松、开放和积极的方法。归根结底,这是由捐献自己空闲时间的人们开发和维护的自由软件。

您可以在中阅读有关该项目及其起源的更多信息我们的常见问题.

🌟 项目主办人

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

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

金牌赞助商

联邦计算机

铜牌赞助商

图表.net 云朵之上
Practical公司 恒星托管
NETWAYS Web服务 Schroeck IT咨询

🛣️ 路线图

下面是BookStack的高级路线图视图,以提供项目方向感。这可能会在任何时候发生变化,并且不会反映出许多功能和改进,这些功能和改进也将作为本路线图的一部分包含在内。有关即将发布的版本中包含的内容的详细信息,您可以查看我们的发布过程文档。

  • 平台REST API-(大多数行动已实施,正在成熟)
    • RESTAPI至少涵盖了对核心内容模型(书籍、章节、页面)的控制,以实现自动化和平台扩展。
  • 权限系统审查-(进行中)
    • 改进权限的应用方式,并审查权限和角色系统的效率。

🛠️ 开发与测试

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

如果您只是想定制或扩展自己的BookStack实例,请查看我们的黑客BookStack文档页面有关在不更改BookStack源代码的情况下实现此目的的各种选项的详细信息。

BookStack版本控制方案和一般发布流程的详细信息可以在这里找到.

🌎 翻译

BookStack中文本的翻译通过Crowdin上的BookStack项目。某些字符串具有冒号前缀变量,例如:用户名。保持这些值不变,因为它们将在运行时被替换。

请使用克劳丁贡献翻译而不是打开pull请求。工作代码库中的翻译可能过时,通过代码合并可能会导致冲突和同步问题。如果出于某种原因,您无法使用Crowdin,请随时提出问题,讨论其他选项。

如果您想在Crowdin中添加一种新语言,以便能够为提供翻译,请在此处打开新一期.

请注意,BookStack中的翻译被提供给“Crowdin Global Translation Memory”,它有助于BookStach和其他项目查找翻译。如果您对此不满意,则不建议向BookStack提供翻译,即使是通过GitHub手动提供。

🎁 贡献、问题和拉动请求

请随意创建问题请求新功能或报告错误和问题。创建问题时,请遵循给定的模板。

拉请求是受欢迎的,但除非是一个小的调整,否则最好尽早打开拉请求,或为您的预期更改创建一个问题,以讨论它如何适合项目并规划合并。仅仅因为功能请求存在或被标记,并不意味着该功能将被接受到核心项目中。

拉入请求应该从发展分支,因为它们将合并回发展一旦完成。请不要从生成或请求合并到释放分支,因为这仅适用于发布版本。如果您想更改CSS或JavaScript内容,请编辑中的源文件资源/中的任何CSS或JS文件公众的是根据这些源文件生成的,因此不应直接编辑。

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

🔒 安全

管理BookStack实例的安全信息可以在此处为文档站点.

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

如果您想报告安全问题,请提供详细信息可以在这里找到.

无障碍

我们希望BookStack能够让尽可能多的人访问。我们的目标是尽可能至少达到WCAG 2.1 A级标准,尽管我们没有在每个版本中严格测试。如果您遇到任何可访问性问题,请随时提出问题。

🖥️ 网站、文档和博客

包含项目文档和博客的网站可以在BookStackApp/网站回购。

⚖️ 许可证

BookStack源位于麻省理工学院许可证.

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

👪 归因

致力于构建和改进BookStack的伟人可以在这里可以看到。通过GitHub或Crowdin提供翻译的优秀人员可以在这里看到.

以下是用于帮助构建BookStack的伟大开源项目。注意:这并不是活动BookStack实例中使用的所有库和项目的详尽列表。

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