Cool_Tools/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-13 18:40:54 +01:00
Code Issues Releases Wiki Activity
2892706b70
mkdocs-material/docs/insiders/index.md
squidfunk 2892706b70 Updated Insiders documentation
2022-06-24 15:49:54 +02:00

19 KiB
Raw Blame History

template title
overrides/main.html Insiders

Insiders

Material for MkDocs follows the sponsorware release strategy, which means that new features are first exclusively released to sponsors as part of Insiders. Read on to learn what sponsorships achieve, how to become a sponsor to get access to Insiders, and what's in for you!

This documentation is built with Insiders squidfunk.github.io/mkdocs-material

What is Insiders?

Material for MkDocs Insiders is a private fork of Material for MkDocs, hosted as a private GitHub repository. Almost1 all new features are developed as part of this fork, which means that they are immediately available to all eligible sponsors, as they are made collaborators of this repository.

Every feature is tied to a funding goal in monthly subscriptions. When a funding goal is hit, the features that are tied to it are merged back into Material for MkDocs and released for general availability, making them available to all users. Bugfixes are always released in tandem.

Sponsorships start as low as $10 a month.2

What sponsorships achieve

Sponsorships make this project sustainable, as they buy the maintainers of this project time – a very scarce resource – which is spent on the development of new features, bug fixing, stability improvement, issue triage and general support. The biggest bottleneck in Open Source is time.3

If you're unsure if you should sponsor this project, check out the list of completed funding goals to learn whether you're already using features that were developed with the help of sponsorships. You're most likely using at least a handful of them, thanks to our awesome sponsors!

How to become a sponsor

Thanks for your interest in sponsoring! In order to become an eligible sponsor with your GitHub account, visit squidfunk's sponsor profile, and complete a sponsorship of $10 a month or more. You can use your individual or organization GitHub account for sponsoring.

Important: If you're sponsoring @squidfunk through a GitHub organization, please send a short email to sponsors@squidfunk.com with the name of your organization and the GitHub account of the individual that should be added as a collaborator.4

You can cancel your sponsorship anytime.5

:octicons-heart-fill-24:{ .mdx-heart }   Join our awesome sponsors{ .md-button .md-button--primary .mdx-sponsorship-button }

Special thanks to our premium sponsors:

Cirrus CI{ target=_blank title="Cirrus CI" } Basler{ target=_blank title="Basler" } Hummingbot{ target=_blank title="Hummingbot" } KX{ target=_blank title="KX Systems" } Manticore Games{ target=_blank title="Manticore Games" } Account technologies{ target=_blank title="Account technologies" } Prefect{ target=_blank title="Prefect" } Datadog{ target=_blank title="Datadog" } Zenoss{ target=_blank title="Zenoss" } Elli{ target=_blank title="Elli - A Brand of the Volkswagen Group" } RStudio{ target=_blank title="RStudio" } n8n{ target=_blank title="n8n" } Dogado{ target=_blank title="Dogado" } World Wide Technology{ target=_blank title="World Wide Technology" } Coda{ target=_blank title="Coda" }

If you sponsor publicly, you're automatically added here with a link to your profile and avatar to show your support for Material for MkDocs. Alternatively, if you wish to keep your sponsorship private, you'll be a silent +1. You can select visibility during checkout and change it afterwards.

What's in for me?

The moment you become a sponsor, you'll get immediate access to 25 additional features that you can start using right away, and which are currently exclusively available to sponsors:

New features are added every other week. Be sure to come back.

Funding

Goals

The following section lists all funding goals. Each goal contains a list of features prefixed with a checkmark symbol, denoting whether a feature is :octicons-check-circle-fill-24:{ style="color: #00e676" } already available or :octicons-check-circle-fill-24:{ style="color: var(--md-default-fg-color--lightest)" } planned, but not yet implemented. When the funding goal is hit, the features are released for general availability.

$ 7,000 – Royal Gold

$ 8,000 – Scotch Bonnet

$ 10,000 – Carolina Reaper

$ 12,000 – Piri Piri

$ 14,000 – Goat's Horn

$ 16,000 – Chipotle

Goals completed

This section lists all funding goals that were previously completed, which means that those features were part of Insiders, but are now generally available and can be used by all users.

$ 6,000 – Trinidad Scorpion

$ 5,000 – Aji Panca

$ 4,000 – Ghost Pepper

$ 3,000 – Caribbean Red

$ 2,500 – Biquinho Vermelho

$ 2,000 – Black Pearl

$ 1,500 – Bhut Jolokia

$ 1,000 – Prairie Fire

$ 500 – Madame Jeanette

  • Improved search result grouping
  • Improved search result relevance and scoring
  • Missing query terms in search results

Frequently asked questions

Compatibility

We're running an open source project and want to make sure that users can change and build the documentation without having access to Insiders. Is this still possible?

Yes. Insiders is compatible with Material for MkDocs. Almost all new features are implemented behind feature flags; almost all configuration changes are backward-compatible. This means that developers will be able to build the documentation locally with Material for MkDocs and when they push their changes, it can be built with Insiders (e.g. as part of GitHub Actions).

When using built-in plugins that are solely available via Insiders, it might be necessary to split the mkdocs.yml configuration into a base configuration, and one with plugin overrides. Note that this is a limitation of MkDocs, which can be mitigated by using configuration inheritance.

See the getting started guide for more information.

Payment

We don't want to pay for sponsorship every month. Are there any other options?

Yes. You can sponsor on a yearly basis by switching your GitHub account to a yearly billing cycle. If for some reason you cannot do that, you could also create a dedicated GitHub account with a yearly billing cycle, which you only use for sponsoring (some sponsors already do that).

If you have any problems or further questions, please reach out to sponsors@squidfunk.com.

Terms

Are we allowed to use Insiders under the same terms and conditions as Material for MkDocs?

Yes. Whether you're an individual or a company, you may use Material for MkDocs Insiders precisely under the same terms as Material for MkDocs, which are given by the MIT license. However, we kindly ask you to respect the following guidelines:

  • Please don't distribute the source code of Insiders. You may freely use it for public, private or commercial projects, privately fork or mirror it, but please don't make the source code public, as it would counteract the sponsorware strategy.

  • If you cancel your subscription, you're automatically removed as a collaborator and will miss out on all future updates of Insiders. However, you may use the latest version that's available to you as long as you like. Just remember that GitHub deletes private forks.

  1. In general, every new feature is first exclusively released to sponsors, but sometimes upstream dependencies like Python Markdown Extensions enhance existing features that must be supported by Material for MkDocs. ↩︎

  2. Note that $10 a month is the minimum amount to become eligible for Insiders. While GitHub Sponsors also allows to sponsor lower amounts or one-time amounts, those can't be granted access to Insiders due to technical reasons. ↩︎

  3. Making an Open Source project sustainable is exceptionally hard: maintainers burn out, projects are abandoned. That's not great and very unpredictable. The sponsorware model ensures that if you decide to use Material for MkDocs, you can be sure that bugs are fixed quickly and new features are added regularly. ↩︎

  4. It's currently not possible to grant access to each member of an organization, as GitHub only allows for adding users. Thus, after sponsoring, please send an email to sponsors@squidfunk.com, stating which account should become a collaborator of the Insiders repository. We're working on a solution which will make access to organizations much simpler. To ensure that access is not tied to a particular individual GitHub account, create a bot account (i.e. a GitHub account that is not tied to a specific individual), and use this account for the sponsoring. After being added to the list of collaborators, the bot account can create a private fork of the private Insiders GitHub repository, and grant access to all members of the organizations. ↩︎

  5. If you cancel your sponsorship, GitHub schedules a cancellation request which will become effective at the end of the billing cycle. This means that even though you cancel your sponsorship, you will keep your access to Insiders as long as your cancellation isn't effective. All charges are processed by GitHub through Stripe. As we don't receive any information regarding your payment, and GitHub doesn't offer refunds, sponsorships are non-refundable. ↩︎