4.7 KiB
| template |
|---|
| overrides/main.html |
Sponsorship :logo: :material-plus: :octicons-heart-fill-24:
Material for MkDocs uses the sponsorware release strategy, which means that new features are first exclusively released to sponsors. Read on to learn how sponsorship works and how you can become a sponsor to enjoy the latest features before everybody else.
How sponsorship works
Material for MkDocs is split into a community edition and a sponsor edition.
New features will first land in the sponsor edition, which means that sponsors will have access immediately. Every feature is tied to a funding goal in monthly subscriptions. If this funding goal is hit, the feature is merged into the community edition and released to the public to be generally available. Bugs will be fixed in the community edition and merged back into the sponsor edition.
See the roadmap for a list of available and upcoming features of the sponsor edition, and for demonstration purposes, the official docs built with the sponsor edition.
How to become a sponsor
You've decided to become a sponsor? Great! You're just three easy steps away from enjoying the latest features of Material for MkDocs. 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 above $10/month. Select the tier and complete the checkout.
- Within 24 hours, you will be added as a collaborator to a private GitHub repository, which contains a fork of Material for MkDocs with brand new and exclusive features.
- Create a personal access token, which allows installing the sponsor edition of Material for MkDocs from any destination, including other CI providers like GitLab or Bitbucket.
Congratulations! 🥳 You're now officially a sponsor and can use the sponsor edition until you decide to cancel your monthly subscription, which you're free to do at any time.
Roadmap
The following list of funding goals – named after varieties of chili peppers I'm growing on my balcony – shows, which features are already part of the sponsor edition or yet to come.
Madame Jeanette
:octicons-fire-24: Funding goal: $500 · :octicons-lock-24: Status: exclusively available
Improve search UI and UX to show relevant results more prominently, show missing terms that were not found on a specific page and highlight terms found when following a search result.
- #1790 – Added grouping of search results
- #1799 – Added missing query terms to search result
- #1799 – Improved search result relevance and scoring
- TBD – Improved search result summaries
- TBD – Added highlighting of query terms on target pages
Bhut Jolokia
:octicons-fire-24: Funding goal: $1,500 · :octicons-lock-24: Status: pending
Add native support to Material for MkDocs to build and deploy multiple versions of a single documentation project, with the help of a plugin.
Caribbean Red
:octicons-fire-24: Funding goal: $3,000 · :octicons-lock-24: Status: pending
Add an alternative, completely different vertical layout, optimized to read documentation and code side-by-side, e.g. for the documentation of APIs.
Terms
Regardless of whether you're an individual or a company, you may use the sponsor edition exactly under the same terms as the community edition, 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 the sponsor edition. You may freely use it for public, private or commercial projects, fork it, mirror it, do whatever you want with it, as long as you're not releasing the source code, as this would cannibalize the sponsorware model.
-
If you cancel your subscription, you're removed as a collaborator and will not receive future updates of the sponsor edition. However, you may continue to use the latest version that's available to you for as long as you like. Just remember that GitHub deletes private forks.