内部版本

Material for MkDocs遵循__赞助软件__的发布策略，这意味着新功能首先作为Insiders的一部分专门向赞助者发布。请继续阅读以了解[sponsorships能够实现什么]，[如何成为赞助者]以获得Insiders的访问权限，以及[对您有何好处]！

什么是Insiders？

Material for MkDocs Insiders是Material for MkDocs的私有分支，作为私有GitHub存储库托管。几乎¹ 所有新功能都作为此分支的一部分开发，这意味着只要赞助者符合条件，他们就可以立即使用这些功能，因为他们被添加为该存储库的合作者。

每个功能都与一个资金目标相关联，该目标是基于每月订阅。当达到资金目标时，与之相关的功能将合并回Material for MkDocs，并发布供所有用户使用，使其对所有用户可用。Bug修复始终同时发布。

赞助的起点只需每月15美元以上。²

赞助可以实现什么

赞助使这个项目可持续发展，因为它们为这个项目的维护者购买了时间 - 这是一种非常稀缺的资源 - 这些时间用于开发新功能、修复错误、提高稳定性、问题分类和提供一般支持。开源项目最大的瓶颈是时间。³

如果您不确定是否应该赞助这个项目，请查看已完成的资金目标列表，了解您是否已经使用了通过赞助开发的功能。您很可能已经使用了其中至少一部分功能，感谢我们了不起的赞助者！

对我有何好处？

一旦成为赞助者，您将立即获得__23个额外功能的即时访问权限__，您可以__立即开始使用__，这些功能目前仅提供给赞助者：

每两周添加新功能。记得回来看看。

如何成为赞助者

感谢您有意赞助！要使用您的GitHub帐户成为合格的赞助者，请访问[squidfunk的赞助者资料]，并完成每月15美元或更多的赞助。您可以使用个人或组织的GitHub帐户进行赞助。

重要：如果您通过GitHub组织赞助@squidfunk，请发送一封简短的电子邮件至sponsors@squidfunk.com，提供您的组织名称和应添加为合作者的个人的GitHub帐户。⁴

您可以随时取消赞助。⁵

加入我们的了不起的赞助者

银牌赞助商：

铜牌赞助商：

资金

目标

下面的部分列出了所有的资金目标。每个目标都包含一个以勾号符号为前缀的功能列表，表示该功能是否已经可用或计划中但尚未实现。当达到资金目标时，这些功能将发布供所有用户使用。

$ 14,000 – 山羊角

$ 16,000 – 墨西哥辣椒

$ 20,000 – 墨西哥辣椒

$ 24,000 – Blockpaprika

已完成的目标

本部分列出了以前完成的所有资金目标，这意味着这些功能是Insiders的一部分，但现在已经普遍可用，所有用户都可以使用。

$ 12,000 – Piri Piri

$ 10,000 – Carolina Reaper

$ 8,000 – Scotch Bonnet

$ 7,000 – Royal Gold

$ 6,000 – Trinidad Scorpion

[增强搜索结果分组]
[改进的搜索结果相关性和评分]
[搜索结果中缺少的查询项]

$ 5,000 – Aji Panca

[Mermaid.js集成]
切换版本时保持在页面上
[搜索集成的标签]

$ 4,000 – Ghost Pepper

[Anchor跟踪]
[代码注释]
[版本警告]

$ 3,000 – Caribbean Red

[粘性导航选项卡]
[章节索引页面]
[删除生成器通知]

$ 2,500 – Biquinho Vermelho

[搜索建议]
[搜索高亮]
[搜索共享]

$ 2,000 – Black Pearl

最新发布标签
[颜色调色板切换]
[返回顶部按钮]

$ 1,500 – Bhut Jolokia

[Admonition内联块]
[站点语言选择]
[版本控制]

$ 1,000 – Prairie Fire

$ 500 – Madame Jeanette

改进的搜索结果分组
改进的搜索结果相关性和评分
搜索结果中缺少的查询项

常见问题

兼容性

我们正在构建一个开源项目，并希望允许外部协作者在没有Insiders访问权限的情况下本地运行和构建我们的文档。这仍然可能吗？

是的。Insiders与Material for MkDocs兼容。几乎所有新功能和配置选项都是向后兼容的，或者在功能标志后面实现。与外部协作者一起工作时，很少需要更改站点的一般外观。大多数Insiders功能增强了整体体验，例如为页面添加图标或提供反馈小部件。虽然这些功能为您的站点的用户增加了价值，但在预览时更改内容时，它们不应该是必需的。目前，Insiders中与内容相关的功能，非Insiders用户无法正确预览的功能有：

这意味着外部协作者能够使用Material for MkDocs在本地构建文档，当他们推送更改时，您的CI流水线将使用Insiders构建。当使用Insiders独有的内置插件时，建议将配置拆分为基本的mkdocs.yml和一个具有插件覆盖的配置，通过配置继承。

有关更多信息，请参阅入门指南。

付款

我们不想每个月支付赞助费。是否有其他选择？

是的。您可以通过将您的GitHub帐户切换到年度计费周期来进行年度赞助。如果由于某种原因您无法这样做，您还可以创建一个专用的GitHub帐户，并将其设置为年度计费周期，仅用于赞助（一些赞助者已经这样做）。

如果您遇到任何问题或有进一步的问题，请联系sponsors@squidfunk.com。

条款

我们是否可以在与Material for MkDocs相同的条款和条件下使用Insiders？

是的。无论您是个人还是公司，您都可以按照与Material for MkDocs相同的条款使用_Material for MkDocs Insiders_，这些条款由[MIT许可证]规定。但是，我们恳请您遵守我们的__公平使用政策

通常，每个新功能都首先独家发布给赞助者，但有时上游依赖项（如Python Markdown Extensions）会增强现有功能，这些功能必须由Material for MkDocs支持。 ↩
请注意，每月15美元是成为Insiders资格的最低金额。虽然GitHub赞助商也允许赞助更低金额或一次性金额，但由于技术原因，这些金额无法获得Insiders的访问权限。 ↩
使开源项目可持续发展非常困难：维护者会疲惫不堪，项目会被废弃。这并不好，而且非常不可预测。赞助软件模型确保如果您决定使用Material for MkDocs，您可以确保错误会被快速修复，并且新功能会定期添加。 ↩
目前无法授予组织的每个成员访问权限，因为GitHub只允许添加用户。因此，在赞助后，请发送电子邮件至sponsors@squidfunk.com，说明哪个帐户应成为Insiders存储库的协作者。我们正在研究一种解决方案，使组织的访问变得更加简单。为了确保访问不与特定个人的GitHub帐户相关联，创建一个机器人帐户（即不与特定个人相关联的GitHub帐户），并将此帐户用于赞助。在被添加到协作者列表后，机器人帐户可以创建私有Insiders GitHub存储库的分叉，并授予组织的所有成员访问权限。 ↩
如果取消赞助，GitHub会安排取消请求，该请求将在计费周期结束时生效。这意味着即使取消赞助，只要您的取消请求尚未生效，您将保留对Insiders的访问权限。所有费用由GitHub通过Stripe处理。由于我们不会收到有关您的付款的任何信息，而且GitHub不提供退款，因此赞助费用不可退还。 ↩