Skip to content

赞助常见问题解答

您对 Material for MkDocs Insiders 有疑问吗?我们将尽力在本页面上回答您的所有问题。如果您在下面找不到您的问题,请在我们的讨论板上提问!

一般

为什么 Insiders 版本采用订阅模式?

Material for MkDocs 一直以来都是开源的,对个人和组织免费提供。随着项目的发展,我们发现随着项目规模的增长,维护和管理所带来的负担变得更加具有挑战性和耗时。

为了维持项目并更频繁地添加新的有用功能,我们决定创建Insiders版本,提供对 Material for MkDocs 最新和最好功能的早期访问。Insiders 版本的订阅模式使我们能够投入更多的时间和资源到项目中,这将使所有 Material for MkDocs 的用户受益。一旦我们基于每月订阅的资金目标达到,这些资金目标的 Insiders 功能就会发布到社区版本中,让每个人都能从中受益。

同时维护社区版和 Insiders 版是一个持续的过程,我们依赖于赞助商每月的支持,这使整个项目成为可能。

Insiders 版本包含哪些功能?

Insiders 版本包括了 20 多个额外的功能。您可以在我们的[Insiders 页面]上找到这些功能的概述,该页面会在添加和发布新功能时进行更新。

Insiders 版本多久更新一次?

我们努力保持我们的开放问题数量较少,迅速修复已知的错误。我们的社区和 Insiders 版本的仓库都会不断更新,修复错误并添加新功能。

赞助

我能否在没有 GitHub 账户的情况下赞助该项目?

可以。您可以通过在Ko-fi上赞助 Material for MkDocs 来支持我们,无论您是否拥有 GitHub 账户。然而,请注意,Insiders 版本是在 GitHub 上作为私有仓库提供的。如果在赞助之后,您希望获得对该仓库的访问权限,您需要拥有一个 GitHub 个人或机器人账户,并将其添加为协作者。如果您的组织不使用 GitHub 或在其他平台上托管其仓库,您可以在获得访问权限后在您的环境中镜像 Insiders 仓库。

我应该选择哪个赞助等级?

赞助等级分为非商业和商业两个层级。如果您是个人或组织,用于私人或非商业的开源项目使用 Material for MkDocs,您可以选择两个不同的层级,具体取决于您想要构建的站点数量。对于使用 Material for MkDocs 的公司,我们提供三个不同的商业层级,您可以根据自己的需求选择。

另外,请阅读关于什么属于商业用途的说明。

为什么一次性赞助无法获得对 Insiders 的访问权限?

主要是由于技术原因,我们正在努力在未来解决这个问题。我们使用 GitHub Webhooks 来确定当前的活跃赞助商。当您创建或取消您的月度订阅时,GitHub 会发送事件,我们使用这些事件来自动添加和删除协作者。

请注意,$15 是获得对 Insiders 访问权限的最低金额。

我的赞助款项如何用于支持项目?

您的赞助款项直接支持项目的开发和维护,为我们维护者购买时间。它使我们能够投入更多的时间和资源来增强项目的功能和特性。额外的资金帮助我们优先考虑改进和更新,使 Insiders 用户和更广泛的社区受益。我们还积极参与其他上游项目的贡献,促进合作并回馈开源生态系统。

对于特定层级,是否有关于赞助商数量的限制?

不,对于任何层级,没有关于赞助商数量的限制。无论已经有多少其他赞助商,您都可以赞助该项目的任何层级。

付款和账单

Insiders 版本有试用期吗?

不,我们不提供 Insiders 版本的试用期。但是,如果您是一家公司,正在考虑以商业层级赞助,但希望先尝试 Insiders 版本,您可以使用个人账户以 $15 的层级进行赞助,以进行非商业评估。

此外,我们的订阅模式允许您随时取消赞助。如果您决定取消,您的赞助将在您的账单周期结束之前保持有效。

您接受哪些付款方式?

我们通过GitHub SponsorsKo-fi管理所有的交易和赞助。要在 GitHub 上成为 Material for MkDocs 的赞助商,请访问我们的赞助商页面。在那里,您可以选择五种不同的赞助层级,并使用信用卡付款。请注意,从 2023 年初开始,GitHub 不再支持 PayPal支付。如果您希望使用 PayPal 进行付款,您可以在Ko-fi上找到我们的一些赞助层级选择。这两个平台在您的购买成功后会为您提供付款收据。

如果您是一家公司,并且需要帮助选择合适的付款方式,请随时联系 sponsors@squidfunk.com。

Insiders 版本是否提供折扣,例如学生折扣?

不幸的是,我们无法为 Material for MkDocs Insiders 计划提供任何折扣。为了确保每个人都能负担得起 Insiders 计划,并使门槛尽可能低,我们将价格设定为每月 $15 用于非商业用途。

您是否为开源项目提供免费的 Insiders 访问权限?

不,我们不为 Material for MkDocs Insiders 版本提供免费访问权限。我们理解非营利组织的预算可能有限,他们可能需要将支出优先考虑在其他项目或组织上。然而,重要的是要注意,Material for MkDocs 是由一个小团队维护的,他们投入了大量时间和资源不断改进这个项目。Material for MkDocs 本身已经是免费提供给社区的。

然而,我们提供了一个价格合理的赞助层级,起价为每月 $15,适用于个人和非营利组织,用于构建 1-2 个非商业用途的站点。该层级提供对所有新功能的访问,使您受益于我们持续的开发工作。

对于为该项目做出贡献的人,Insiders 是否免费?

很好的问题!我们无法为“偶尔参与”的贡献者提供免费的 Insiders 访问权限,这些贡献者只是修复了一些次要问题,比如拼写错误或添加新的语言。这些贡献总是受欢迎的,但由于我们需要审查它们,它们会导致我们投入更多的时间,而无法对此工作进行补偿。然而,随着这个项目的不断发展,我们始终在寻找愿意支持我们的个人。作为回报,我们提供财务补偿和/或 Insiders 访问权限。如果您对下面列出的技术和范例有兴趣,请通过 sponsors@squidfunk.com 与我们联系:

  • 对 CSS、HTML、TypeScript 的深入了解
  • 有渐进增强和响应式设计经验
  • 有使用 RxJS 进行响应式编程的经验
  • 对 Python、MkDocs + 生态系统有扎实的理解
  • 扎实的技术写作能力

此外,我们正在制定一个贡献者计划,将向通过回答问题和帮助用户参与社区的贡献者提供 Insiders 访问权限。

如何将我的计费设置为每月或每年?

您可以按月或按年赞助 Material for MkDocs。根据您的账单周期,您将自动成为月度或年度赞助商。您的billing cycle是一个账户级别的设置,您可以在您的账户中轻松更改。如果由于某种原因您无法进行此更改,您可以在 GitHub 上创建一个专用的机器人账户,该账户具有年度计费周期,您只需将其用于赞助(一些赞助商已经这样做了)。如果您遇到任何问题或有进一步的问题,请通过 sponsors@squidfunk.com 与我们联系。

我能否获得赞助付款的发票?

目前,我们无法为您的赞助交易提供发票,因为GitHub Sponsors为我们处理所有交易。然而,这两个付款平台,GitHubKo-Fi,一旦您的赞助成功,会自动通过电子邮件向您发送付款收据。

此外,我们正在努力解决访问管理和更多功能的问题。如果您对此感兴趣,请通过电子邮件联系我们,地址是 sponsors@squidfunk.com,或者打开对 MkDocs 的所有通知,我们将尽快与您联系。

我可以在不同的赞助层级之间切换吗?

是的,您可以随时在不同的赞助层级之间切换。只需访问GitHub Sponsors页面并更改您的赞助层级。一旦您进行了更改,您将立即切换到新的层级。

如果您切换到更高的层级,金额将按您的账单周期进行比例分配。

我可以为特定功能或开发目标赞助该项目吗?

虽然直接赞助特定目标是不可能的,但我们的赞助目标与项目的路线图中的特定功能或开发目标相关联。您可以在我们的网站上找到这些赞助目标及其相关功能的概述。Insider 用户可以提前访问所有已经开发的功能,包括与更高的资金目标相关的功能,这些功能将在后期实现。如果您有一个想要在列表中看到的功能,请发起一个新的讨论与其他人一起评估。

如果我达到了当前层级的赞助限额,会发生什么?

如果您扩展了当前赞助限额的站点数量,请升级您的赞助到更高的层级以继续使用 Insiders 版本并构建更多站点。更改将立即生效。

赞助付款是否可以退款?

不幸的是,我们无法为赞助付款提供任何退款。GitHub SponsorsKo-Fi管理所有的赞助交易。因此,我们无法了解资金的详细信息,也无法访问它们。如果您有任何付款问题,请与 GitHub 或 Ko-Fi 支持团队联系,因为他们可以为您提供帮助。

访问管理

如何获得对私有 Insiders 仓库的访问权限?

如果您使用个人账户进行赞助,您应该在开始赞助后立即收到私有 Material for MkDocs Insiders 仓库的电子邮件邀请。只需在七天内接受邀请即可获得访问权限。

如果您使用组织账户进行赞助,请注意我们需要一个个人账户,我们可以将其列为私有 Insiders 仓库的协作者。在开始赞助后,请通过sponsors@squidfunk.com向我们发送个人或机器人账户的名称。一旦您提供了这些信息,我们将将该账户添加为协作者,并在您接受邀请后,您将获得对仓库的访问权限。

如果您尚未收到电子邮件或邀请链接已过期,请联系我们维护者,地址是sponsors@squidfunk.com。我们正在努力解决一个问题,使您可以自己管理协作者状态。

为什么我们的整个组织无法获得 Insiders 的访问权限?

目前,无法为组织账户授予访问权限,因为 GitHub 只允许添加个人用户账户。我们正在努力找到解决方案,以简化组织的访问权限。目前,为了确保访问权限不与特定个人相关联,我们建议创建一个机器人账户,即一个不属于特定个人的 GitHub 账户,但作为组织账户的所有者列出,并使用此账户进行赞助。

我需要 fork 该仓库才能使用它吗?

这取决于情况。如果您作为个人使用 Insiders 版本,您可以直接使用私有仓库,因为您不需要与他人共享 Insiders 的功能。如果您与团队合作,最好使用您列为 Material for MkDocs 协作者的个人账户创建一个私有 fork,以授权您组织的所有成员访问您的 fork。

我可以与他人共享我的 Insiders 访问权限吗?

目前,无法直接与他人共享您在私有 Insiders 仓库的协作者身份。但是,如果您与团队合作,并希望他们访问 Insiders,您可以通过使用克隆派生镜像等选项共享 Insiders 仓库。通过这种方式,您可以与团队成员共同在您共享的新仓库上进行协作。这样,您可以共同从 Insiders 的功能中受益,并共同开展项目工作。

运行时和取消

我的赞助有效期有多长?

您的赞助有效期取决于您的月度或年度订阅的有效期。如果您选择取消赞助,一旦您的取消生效,您将失去对 Insiders 版本的访问权限,并且将自动从私有仓库的协作者列表中被 GitHub 移除。

如何取消我的赞助?

要取消赞助,请按照 GitHub 提供的逐步指南操作。如果您是使用组织账户进行赞助,请确保使用相同的组织账户取消赞助,而不是您的个人账户。

取消赞助后会发生什么?

如果您选择取消对 Insiders 的订阅,您将被 GitHub 自动从私有仓库的协作者列表中移除,并且从取消生效的那天起,您将不再收到未来的更新。然而,您可以继续使用您在取消订阅时的最新版本,而且没有时间限制。

请注意,GitHub 删除私有派生仓库,因此如果需要,您可能需要采取措施确保您有该软件的备份,并使用本地安装版本。

许可证

Insiders 版本的商业使用是什么意思?

商业使用是指将软件用于商业或盈利目的。这包括任何公司或其他组织的使用,无论他们是否直接从软件中获得收入。我们为商业用途提供了不同的定价层级,每个层级都根据不同企业的需求进行了定制。需要注意的是,在您的组织内部使用该软件也被视为商业使用,就像所有商业软件一样。

Insiders 版本的非商业使用是什么意思?

我们的 Material for MkDocs 的非商业使用指的是私人使用。这包括个人使用 Insiders 版本进行私人或纯粹的非商业开源项目。我们为非商业使用提供了两个不同的层级,具体取决于您想要构建的站点数量。

您的公平使用政策是什么?

我们的公平使用政策包括以下准则:

  • 请不要分发 Insiders 的源代码。尽管您可以将软件用于公共、私人或商业项目,并且可以私下 fork 或镜像它,但我们要求您保持源代码的私密性。这对于我们的赞助软件战略非常重要,它帮助我们为软件的持续开发和支持提供资金。如果违反此准则,将会对所有人造成损失,因为它将减少我们维护者投入到推动这个项目的时间。

  • 由于我们的赞助层级是基于您想要构建的站点数量,因此请确保在达到当前赞助层级限制后升级您的赞助

Insiders 版本是否有不同的许可证?

没有。无论您是个人还是公司,您都可以根据 Material for MkDocs 的相同条款使用 Material for MkDocs Insiders,这些条款由MIT 许可证规定。

非协作者是否可以在没有 Insiders 访问权限的情况下本地构建和运行文档?

是的。Insiders 与 Material for MkDocs 兼容。几乎所有的新功能和配置选项都是向后兼容或在功能标志后实现的。当与外部协作者合作时,更改您站点的总体外观应该是可选的。大多数 Insiders 的功能都增强了整体体验,例如为页面添加图标或提供反馈小部件。尽管这些功能为您站点的用户增加了价值,但在对内容进行更改时,它们应该是可选的。目前,Insiders 版本中与内容相关的唯一功能是[注释]和[卡片网格],非 Insiders 用户无法正确预览这些功能。

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

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

支持

如果我有关于成为赞助商的问题,如何联系支持?

如果在开始赞助之前有任何问题,并希望与我们联系,我们很乐意回答您关于 Insiders 计划的非技术问题。请发送电子邮件至 sponsors@squidfunk.com。

所有技术问题应该在我们的讨论板上公开提问。

Material for MkDocs Insiders 用户是否可以获得额外的支持?

是的,我们提供与赞助相关的非技术支持,您可以通过发送电子邮件至 sponsors@squidfunk.com 联系我们。对于技术问题,请在我们的问题跟踪器上提交问题或在我们的讨论板上发起讨论。我们将优先考虑来自我们组织赞助商的问题和讨论,这些赞助商赞助于“组织”层级或更高层级。1

我如何在列表中显示我的徽标作为高级赞助商?

如果您的赞助层级包括徽标展示,并且您希望我们在高级赞助商列表中显示您的徽标并将其链接到您的网站,请通过电子邮件联系我们。只需向 sponsors@squidfunk.com 发送一个包含您公司名称和徽标的水平 SVG 或 PNG 版本即可。

徽标展示是否可选?

是的,我们的所有商业福利,如徽标展示和返回链接,都是可选的,可以随时选择加入或退出。您可以完全保持赞助的私密性。

我如何报告 Insiders 版本中的错误?

如果您在 Insiders 版本中遇到错误,请在我们的公共社区仓库的问题跟踪器上报告。在提交错误报告时,请确保不包含任何私有的 Insiders 源代码,因为我们希望遵守我们的公平使用政策。

隐私

您是否会签署赞助的保密协议(NDA)?

不幸的是,我们无法签署任何保密协议或供应商协议。作为一个小团队,我们在 Material for MkDocs 上工作的资源有限,无法审查和签署协议。

我可以私下赞助吗?

是的,您可以。GitHub 在设置赞助时提供了私密选项。此外,我们为您推荐以下工作流程:我们建议您创建一个新的 GitHub 机器人账户。这个机器人账户不应与特定个人相关联,并且应作为您的 GitHub 组织的所有者私下列出。您可以使用此账户进行私下赞助 Material for MkDocs。作为机器人账户,它将自动列为私有 Insiders 仓库的协作者。您可以使用此账户进行克隆、派生或镜像。所有信息将保密;只有机器人账户和我们的维护者能够了解这个赞助。

成为赞助商是否有地理限制?

不,成为赞助商没有地理限制。我们欢迎来自全球各地的个人和组织的赞助。只要您的信用卡有效并被 GitHub 或 Ko-Fi 接受,您就有资格成为赞助商,并支持该项目,无论您所在的位置在哪里。


  1. 优先支持意味着我们将优先考虑您的问题,即我们将研究并尽力尽快解决您的问题。然而,优先处理错误支持并不意味着我们可以在其他问题之前解决您的问题,因为某些问题可能需要更长的时间来解决。