OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity
d754bd9a71
mkdocs-material/docs/insiders.md
squidfunk 7f30099bd4 Added note on sponsoring via organizations
2020-12-15 15:52:26 +01:00

12 KiB
Raw Blame History

template
overrides/main.html

Insiders :logo: :material-plus: :octicons-heart-fill-24:{: .tx-heart }

Material for MkDocs uses the sponsorware release strategy, which means that new features are first exclusively released to sponsors as part of Material for MkDocs Insiders. Read on to learn how sponsorship works, and how you can become a sponsor.

A demo is worth a thousand words — check it out at
squidfunk.github.io/mkdocs-material-insiders

How sponsorship works

New features will first land in Material for MkDocs Insiders, which means that sponsors will have access immediately. Every feature is tied to a funding goal in monthly subscriptions. If a funding goal is hit, the features that are tied to it are merged back into Material for MkDocs and released for general availability. Bugfixes will always be released simultaneously in both editions.

See the roadmap for a list of already available and upcoming features, and for demonstration purposes, the official documentation built with Material for MkDocs Insiders.

Join awesome sponsors

You can sponsor publicly or privately. As a public sponsor, you'll be listed here with your GitHub avatar, showing your support for Material for MkDocs!

  Become a sponsor

How to become a sponsor

So you've decided to become a sponsor? Great! You're just three easy steps away from enjoying the latest features of Material for MkDocs Insiders. Complete the following steps and you're in:

  • Visit squidfunk's sponsor profile and pick a tier that includes exclusive access to squidfunk's sponsorware, which is any tier from $10/month. Select the tier and complete the checkout.
  • Within 24 hours, you will become a collaborator of the private Material for MkDocs Insiders GitHub repository, a fork of Material for MkDocs with brand new and exclusive features.
  • Create a personal access token, which allows installing Material for MkDocs Insiders from any destination, including other CI providers like GitLab or Bitbucket.

Congratulations! 🥳 You're now officially a sponsor and will get updates for Material for MkDocs Insiders, until you decide to cancel your monthly subscription, which you can do at any time.

??? info "Sponsoring via a GitHub organization?"

If you sponsor @squidfunk through a GitHub organization (which is currently
in beta), please note that it's not possible to grant access to all
organization members, as GitHub does not allow to do that. Thus, after
sponsoring, please send an email to sponsors@squidfunk.com, explaining
which account should become a collaborator of the Insiders repository.
To ensure that access is not tied to a particular individual, it's best to
create a bot account (i.e. a GitHub account that is not tied to a specific
individual), and use that 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, effectively granting access to all members.

Available features

The following list shows which features are currently only available in Material for MkDocs Insiders. You can click on each feature to learn more about it:

Roadmap

The following list of funding goals – named after varieties of chili peppers I'm growing on my balcony – shows which features are already available in Material for MkDocs Insiders.

Madame Jeanette

:octicons-flame-24: Funding goal: $500 · :octicons-unlock-24: Status: Generally available

  • Improved search result grouping (pages + headings)
  • Improved search result relevance and scoring
  • Display of missing query terms in search results

Prairie Fire

:octicons-flame-24: Funding goal: $1,000 · :octicons-lock-24: Status: Insiders only

Bhut Jolokia

:octicons-flame-24: Funding goal: $1,500 · :octicons-lock-24: Status: Insiders only

Black Pearl

:octicons-flame-24: Funding goal: $2,000 · :octicons-lock-24: Status: Insiders only

Biquinho Vermelho

:octicons-flame-24: Funding goal: $2,500 · :octicons-lock-24: Status: Insiders only

Caribbean Red

:octicons-flame-24: Funding goal: $3,000 · :octicons-lock-24: Status: Insiders only

Frequently asked questions

Compatibility

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

Yes. Material for MkDocs Insiders strives to be compatible with Material for MkDocs, so all new features are implemented as feature flags and all improvements (e.g. search) do not require any changes to existing configuration. This means that your users will be able to build the docs locally with the regular version and when they push their changes to CI/CD, they will be built with Material for MkDocs Insiders. For this reason, it's recommended to install Insiders only in CI, as you don't want to expose your GH_TOKEN to users.

Terms

We're using Material for MkDocs to build the developer documentation of a commercial project. Can we use Material for MkDocs Insiders under the same terms?

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 from Material for MkDocs Insiders. You may freely use it for public, private or commercial projects, fork it, mirror it, do whatever you want with it, but please don't release the source code, as it would cannibalize the sponsorware strategy.

  • If you cancel your subscription, you're removed as a collaborator and will miss out on future updates of Material for MkDocs 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.