mkdocs-material/docs/insiders.md

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.

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.

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-fire-24: Funding goal: $500 · :octicons-lock-24: Status: exclusive

New features and improvements for search, including:

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

Prairie Fire

:octicons-fire-24: Funding goal: $1,000 · :octicons-lock-24: Status: exclusive

New features and improvements for content and toc, including:

• Highlighting of matched search terms in content area
• Navigation can always be expanded via configuration
• Header can be automatically hidden on scrolling
• Table of contents can be automatically hidden when empty
• Table of contents can be moved into navigation for more space
• Table of contents shows which sections have search results
• Table of contents auto-collapses and expands only the active section
• Better support for wide screens, i.e. more horizontal space
• ... more to come

Bhut Jolokia

:octicons-fire-24: Funding goal: $1,500 · :octicons-lock-24: Status: exclusive

New features and improvements for hosting multiple versions, including:

• Support for multiple languages of documents
• Support for multiple versions of documents
• Support for one or more management plugins
• ... more to come

Black Pearl

:octicons-fire-24: Funding goal: $2,000 · :octicons-lock-24: Status: exclusive

New features and improvements for user preferences, including:

• Support for user-toggleable themes
• Support for user-toggleable code-block styles (light/dark)
• Display last searches when search is empty
• ... more to come

Caribbean Red

:octicons-fire-24: Funding goal: $3,000 · :octicons-lock-24: Status: exclusive

Alternative, completely different vertical layout, optimized to read documentation and code side-by-side, e.g. for the documentation of APIs with the same functionality as Material for MkDocs.

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.