访问管理¶

¥Access management¶

MkDocs Insiders 的 Material 仓库是托管在 GitHub 上的私有仓库，因此访问权限通过 GitHub 进行管理。本节涵盖了访问 MkDocs Insiders 私有仓库所需了解的所有内容。

¥The Material for MkDocs Insiders repository is a private repository hosted on GitHub and access is, therefore, managed through GitHub. This section covers everything you need to know in order to gain access to the private Material for MkDocs Insiders repository.

如何获取访问权限¶

¥How to get access¶

由于 MkDocs Insiders 的私有 Material 仓库托管在 GitHub 上，您需要一个 GitHub 帐户才能成为赞助商并获得访问权限。通过我们的赞助等级（每月 15 美元起）赞助我们后，您将可以访问私有的 Insiders 仓库。

¥As the private Material for MkDocs Insiders repository is hosted on GitHub, you require a GitHub account to become a sponsor and to gain access. After sponsoring us on one of our sponsoring tiers starting at $15 a month, you'll get access to the private Insiders repository.

请注意，由于技术原因，获取访问权限的过程仅部分自动化。根据您用于成为赞助商的帐户类型，我们可能需要您提供更多信息才能授予访问权限。

¥Please note that the process of gaining access is only partially automatable due to technical reasons. Depending on the type of account you've used to become a sponsor, we might need more information from you before we can grant access.

个人¶

¥Individuals¶

如果您使用个人帐户赞助，您将在发起赞助后立即通过电子邮件收到一个邀请链接，该链接指向 MkDocs Insiders 私有仓库的 Material for MkDocs Insiders。此链接有效期为七天。接受邀请后，即可开始使用。

¥If you sponsor using a personal account, you will receive an invitation link via email to the private Material for MkDocs Insiders repository immediately after initiating your sponsorship. This link is valid for seven days. Once you accept the invitation, you'll be ready to get started.

如果链接已过期，请通过sponsors@squidfunk.com与我们联系，我们将向您发送新的链接。

¥If the link expired, please contact us at sponsors@squidfunk.com and we'll send you a new one.

组织¶

¥Organizations¶

使用组织帐户进行赞助时，GitHub 不会通过电子邮件发送自动邀请，邀请访问 MkDocs Insiders 私有仓库的 Material。由于GitHub 的限制，无法授予整个组织访问私有仓库的权限。

¥When sponsoring using an organization account, GitHub will not send an automated invitation via email to access the private Material for MkDocs Insiders repository. Due to GitHub limitations, granting access to a private repository for an entire organization is not possible.

因此，在您收到赞助已启动的确认后，请通过sponsors@squidfunk.com与我们联系，并提供个人帐户名称或公开或私下列为您的 GitHub 组织所有者的机器人帐户名称。

¥Therefore, please contact us at sponsors@squidfunk.com with the name of a personal account or the name of a bot account that is publicly or privately listed as an owner of your GitHub organization after you received a confirmation that your sponsorship was initiated.

我们将把该指定帐户添加为合作者，一旦在七天内接受邀请，您的组织就可以开始工作了。

¥We will add this designated account as a collaborator, and once the invitation is accepted within seven days, your organization will be all set to get started.

企业¶

¥Enterprises¶

如果您想使用企业帐户赞助我们，我们建议使用个人帐户或机器人帐户来发起赞助，并使用此帐户访问 MkDocs Insiders 存储库的私人材料。

¥If you would like to sponsor us using an enterprise account, we recommend using a personal account or a bot account to initiate the sponsorship and access the private Material for MkDocs Insiders repository using this account.

限制¶

¥Restrictions¶

GitHub 设置了我们无法控制的限制，这就是为什么我们需要有关私有存储库的合作者和 GitHub 帐户匹配的更多信息。

¥GitHub sets limitations beyond our control, which is why we require further information regarding collaborators of private repositories and matching of GitHub accounts.

合作者¶

¥Collaborators¶

GitHub 策略将私有存储库的访问权限限制为仅限个人帐户，这就是为什么我们目前无法将组织帐户添加到 Material for MkDocs Insiders 存储库（私有存储库）中。

¥GitHub policy limits access to private repositories to personal accounts only, which is why it is currently not possible for us to add organization accounts to the Material for MkDocs Insiders repository – a private repository.

虽然我们很希望为贵组织的每个成员提供访问权限，但添加每个成员账户实在不现实，因此每个赞助等级都限制一个席位。不过，您可以使用机器人账户来解决这个问题。

¥As much as we would love to give each member of your organization access, it's simply not feasible for us to add each member account, which is why every sponsoring tier is limited to one seat. However, you can use a bot account to work around this limitation.

匹配¶

¥Matching¶

由于隐私原因，GitHub 不允许将电子邮件地址与 GitHub 帐户匹配。通过电子邮件sponsors@squidfunk.com申请访问权限时，需要提供个人帐户名称。

¥Due to privacy reasons, GitHub does not allow email addresses to be matched with GitHub accounts. When requesting access via email at sponsors@squidfunk.com, it's necessary to provide us with the name of a personal account.

机器人账户¶

¥Bot account¶

鉴于只有个人账户才能被列为私有仓库的协作者，确保整个组织的访问权限需要通过个人协调。团队内部的变更可能会导致整个组织的访问权限丧失。

¥Given that only personal accounts can be listed as collaborators on private repositories, ensuring access for an entire organization requires coordination through individuals. Changes within the team could lead to losing access to the entire organization.

为了避免这种情况，您可以选择创建一个机器人帐户，这是一个新的个人帐户，不属于特定个人，但公开或私下列为 GitHub 组织的所有者

¥To avoid this, you have the option to create a bot account, which is a new personal account that does not belong to a specific individual but is publicly or privately listed as the owner of the GitHub organization

使用机器人账户进行访问管理并通过它发起您的公共或私人赞助也可以更好地归属赞助成本，让您可以通过单个账户管理所有赞助的访问和付款，因此值得推荐。

¥Using a bot account for access management and initiating your public or private sponsorship through it also allows for better attribution of sponsorship costs, allowing you to manage access and payment for all sponsorships through a single account, and is thus recommended.

邀请已过期¶

¥Expired invitations¶

MkDocs 私人资料的邀请有效期为七天，这是 GitHub 规定的限制。如果您未在此期间接受邀请，请通过sponsors@squidfunk.com邮件联系我们，我们将立即重新发出邀请。

¥The invitation to the private Material for MkDocs is valid for seven days, a limitation imposed by GitHub. If invitations are not accepted within this period, you'll need to contact us via mail at sponsors@squidfunk.com, and we will re-issue the invitation immediately.

团队管理¶

¥Team management¶

如果您以个人身份使用 MkDocs Insiders 的 Material，且不与其他用户协作，则无需fork私有仓库。但是，在团队协作时，无法直接与其他帐户共享您的协作者身份。因此，为了在团队中工作，拥有 Insiders 访问权限的帐户可以fork 、克隆或镜像私有的 MkDocs Insiders Material 仓库到组织，从而为团队协作提供途径。

¥If you are using Material for MkDocs Insiders as an individual and don't collaborate with other users, forking the private repository is not necessary. However, when working with a team, it is not possible to simply share your collaborator status with other accounts. Therefore, in order to work in a team, the account with access to Insiders can fork, clone, or mirror the private Material for MkDocs Insiders repository to an organization, providing a pathway for team collaboration.

外部合作者¶

¥Outside collaborators¶

与外部协作者合作时，您应该知道 Insiders 版本与社区版本兼容。所有新功能和配置选项均向后兼容或通过功能开关实现。大多数 Insiders 功能可以提升整体体验，例如，通过创建更优质的社交卡片或即时预览。虽然这些功能可以为您网站的用户带来价值，但它们对于预览您的网站来说并非必需。

¥When working with outside collaborators, you should know that the Insiders edition is compatible with the community edition. All new features and configuration options are backward-compatible or implemented behind feature flags. Most Insiders features enhance the overall experience, e.g., by creating better social cards or instant previews. While these features add value for your site's users, they are most certainly not necessary for previewing your site.

这意味着外部协作者可以使用社区版在本地构建文档，当他们推送更改时，您的 CI 管道将与内部人员一起构建。使用内部人员专属的内置插件时，我们建议使用群组插件。

¥This means that outside collaborators can build the documentation locally with the community edition, and when they push their changes, your CI pipeline will build it with Insiders. When using built-in plugins exclusive to Insiders, we recommend using the group plugin.

请参阅入门指南以了解更多信息。

¥See the getting started guide for more information.

分叉¶

¥Forking¶

分叉存储库会创建存储库的副本，允许独立开发，同时保持与原始存储库的链接以进行更新。

¥Forking a repository creates a copy of the repository that allows for independent development while maintaining a link to the original repository for updates.

克隆¶

¥Cloning¶

克隆仓库会将仓库复制到您的本地计算机或代码空间，方便离线工作和内容管理。当然，您也可以克隆一个私有分支。

¥Cloning a repository copies the repository to your local machine or codespace, facilitating offline work and content management. You can, of course, also clone a private fork.

镜像¶

¥Mirroring¶

镜像仓库会创建一个完全相同的副本，确保您能够灵活地在 GitHub 以外的其他环境中托管和使用仓库。对于在 GitHub 以外的私有环境中托管仓库的组织来说，这是一种特别有用的策略。

¥Mirroring a repository creates an identical copy, ensuring you have the flexibility to host and work with the repository in other environments besides GitHub. This is a particularly useful strategy for organizations hosting their repositories in a private environment outside of GitHub.

GitHub 替代品¶

¥GitHub alternatives¶

MkDocs Insiders 的 Material 旨在与各种存储库托管平台兼容，包括 GitLab。关键要求仍然是拥有一个 GitHub 帐户，因为我们使用 GitHub Sponsors 进行交易，并使用 GitHub 管理对私有 Insiders 存储库的访问。

¥Material for MkDocs Insiders is designed to be compatible with various repository hosting platforms, including GitLab. The key requirement is still a GitHub account, as we use GitHub Sponsors for transactions and GitHub to manage access to the private Insiders repository.

成为赞助者并通过个人 GitHub 帐户访问 Insiders 私有仓库后，您就可以将该仓库镜像到其他位置。此镜像过程不仅可以轻松集成到您现有的工作流程中，还能确保您的项目始终与 Insiders 的最新功能和改进保持同步。

¥Once you've become a sponsor and secured access to the private Insiders repository via an individual GitHub account, you can mirror the repository in another location. This mirroring process not only allows for easy integration into your existing workflow but also ensures that your projects stay up-to-date with the latest features and improvements of Insiders.

如果您有任何关于将 Material for MkDocs Insiders 集成到项目中的问题，我们的讨论区都是宝贵的资源。它提供了一个平台，让您可以与有类似需求和设置的人交流，并共同交流经验和探索解决方案。

¥Our discussion board is a valuable resource for any questions about integrating Material for MkDocs Insiders into your projects. It offers a space to connect with others who may have similar requirements and setups, as well as to exchange tips and explore solutions together.