diff --git a/docs/insiders/access-management.md b/docs/insiders/access-management.md new file mode 100644 index 00000000000..50e74375eed --- /dev/null +++ b/docs/insiders/access-management.md @@ -0,0 +1,204 @@ +# Access management + +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 + +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. + + [$15 a month]: https://github.com/sponsors/squidfunk/sponsorships?tier_id=210638 + [sponsoring tiers]: sponsoring-tiers.md + +### Individuals + +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]. + +If the link expired, please contact us at sponsors@squidfunk.com and we'll +send you a new one. + + [personal account]: https://docs.github.com/en/get-started/learning-about-github/types-of-github-accounts#personal-accounts + [valid for seven days]: #expired-invitations + [get started]: getting-started.md + +### Organizations + +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. + +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]. + + [organization account]: https://docs.github.com/en/get-started/learning-about-github/types-of-github-accounts#organization-accounts + [GitHub limitations]: #collaborators + [bot account]: #bot-account + [accepted within seven days]: #expired-invitations + +### Enterprises + +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. + + [enterprise account]: https://docs.github.com/en/get-started/learning-about-github/types-of-github-accounts#enterprise-accounts + +## Restrictions + +GitHub sets limitations beyond our control, which is why we require further +information regarding [collaborators] of private repositories and [matching] of +GitHub accounts. + + [collaborators]: #collaborators + [matching]: #matching + +### Collaborators + +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. + + [private repositories]: https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository + [personal accounts]: https://docs.github.com/en/get-started/learning-about-github/types-of-github-accounts#personal-accounts + [organization accounts]: https://docs.github.com/en/get-started/learning-about-github/types-of-github-accounts#organization-accounts + [sponsoring tier]: sponsoring-tiers.md + [team management]: #team-management + +### Matching + +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. + +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. + + [a new personal account]: https://docs.github.com/en/get-started/start-your-journey/creating-an-account-on-github + [public]: privacy.md/#public-sponsors + [private]: privacy.md/#private-sponsors + +## Expired invitations + +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 + +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. + + [fork]: #forking + [clone]: #cloning + [mirror]: #mirroring + [individual]: #individuals + +### Outside collaborators + +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. + +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. + [getting started guide]: getting-started.md + [built-in plugins]: index.md#built-in-plugins + [group]: ../plugins/group.md + +### 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. + + [forking]: https://docs.github.com/en/get-started/quickstart/fork-a-repo + +### 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]. + + [cloning]: https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository + [clone a private fork]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo#cloning-your-forked-repository + +### Mirroring + +[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. + + [mirroring]: https://docs.github.com/en/repositories/creating-and-managing-repositories/duplicating-a-repository + [in other environments]: #github-alternatives + +## GitHub alternatives + +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. + +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. + +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. + + [mirror the repository in another location]: https://docs.github.com/en/repositories/creating-and-managing-repositories/duplicating-a-repository#mirroring-a-repository-in-another-location + [discussion board]: https://github.com/squidfunk/mkdocs-material/discussions diff --git a/docs/insiders/benefits.md b/docs/insiders/benefits.md new file mode 100644 index 00000000000..379a124162e --- /dev/null +++ b/docs/insiders/benefits.md @@ -0,0 +1,343 @@ +# What’s in it for you + +Material for MkDocs Insiders is packed with additional features that are +exclusively available to our monthly sponsors – the moment you become a sponsor, +you'll gain __immediate access__ to all the exclusive Insiders features, ready +for you to __start using now__. + +## Features + +Our sponsors currently enjoy access to the following 26 additional features. New +features are added regularly, so be sure to check back regularly to stay +updated. + +
+ +- [x] [Blog plugin: pinned posts] :material-alert-decagram:{ .mdx-pulse title="Added on February 24, 2024" } +- [x] [Instant previews] :material-alert-decagram:{ .mdx-pulse title="Added on January 28, 2024" } +- [x] [Footnote tooltips] :material-alert-decagram:{ .mdx-pulse title="Added on January 24, 2024" } +- [x] [Tags plugin: advanced settings] +- [x] [Tags plugin: nested tags] +- [x] [Tags plugin: shadow tags] +- [x] [Stay on page when switching languages] +- [x] [Blog plugin: author profiles] +- [x] [Blog plugin: advanced settings] +- [x] [Projects plugin] +- [x] [Instant prefetching] +- [x] [Social plugin: custom layouts] +- [x] [Social plugin: background images] +- [x] [Code range selection] +- [x] [Code annotations: custom selectors] +- [x] [Privacy plugin: advanced settings] +- [x] [Optimize plugin] +- [x] [Navigation path] (Breadcrumbs) +- [x] [Typeset plugin] +- [x] [Privacy plugin: external links] +- [x] [Navigation subtitles] +- [x] [Tags plugin: allow list] + [custom sorting] +- [x] [Blog plugin: custom index pages] +- [x] [Blog plugin: related links] +- [x] [Meta plugin] +- [x] [Tags plugin: configurable listings] + +
+ +## What's coming next + +> Too many ideas, too little time! + +Our backlog is filled with countless ideas that we came up with or that have +been suggested by our community. We're also working to make our roadmap public. +If you have something specific in mind, and wonder whether we've considered it, +feel free to ask on our [discussion board]. + + [discussion board]: https://github.com/squidfunk/mkdocs-material/discussions + +## Frequent releases + +We’re committed to quickly addressing bugs, that come up and keeping our open +issue count as low as possible. Both our community and Insiders editions are +regularly updated, ensuring you have the latest features and fixes available at +all times. + +## Additional benefits + +As a premium sponsors, you'll enjoy additional benefits that are not available +to our individual sponsors. When sponsoring our work on one of our [commercial +tiers] starting at [$125 a month], you'll get additional benefits that we offer +for enterprises: + +- [Prioritized] bug reports to keep your projects running smoothly +- Logo placement and backlink on our site for increased visibility +- Private support via email for any questions to our maintainers + + [commercial tiers]: sponsoring-tiers.md/#commercial-use + [$125 a month]: sponsoring-tiers.md/#the-organization + [list of premium sponsors]: https://github.com/squidfunk/mkdocs-material#user-content-premium-sponsors + [Prioritized]: ../support.md/#prioritized-support + +---- + +Interested in supporting us? Together, let’s continue to make Material for +MkDocs an even more powerful tool for everyone. We’re excited for what the +future holds! + +[:octicons-heart-fill-24:{ .mdx-heart }   Show your support ][sponsoring tiers]{ .md-button .md-button--primary .mdx-sponsorship-button } + + [sponsoring tiers]: sponsoring-tiers.md#commercial-use + +## 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. This means that each funding goal unlocks new +features for general availability in the community edition, after sponsors have +used them for a while. + +#### $ 16,000 – Chipotle + +- [x] [Meta plugin] +- [x] [Blog plugin: related links] +- [x] [Blog plugin: custom index pages] +- [x] [Tags plugin: configurable listings] +- [x] [Tags plugin: allow list] + [custom sorting] +- [x] [Navigation subtitles] + + [Meta plugin]: ../plugins/meta.md + [Blog plugin: related links]: ../setup/setting-up-a-blog.md#adding-related-links + [Blog plugin: custom index pages]: ../setup/setting-up-a-blog.md#custom-index-pages + [Tags plugin: configurable listings]: ../setup/setting-up-tags.md#configurable-listings + [Tags plugin: allow list]: ../plugins/tags.md#config.tags_allowed + [custom sorting]: ../plugins/tags.md#config.tags_sort_by + [Navigation subtitles]: ../reference/index.md#setting-the-page-subtitle + +#### $ 18,000 – Lemon Drop + +- [x] [Optimize plugin] +- [x] [Navigation path] (Breadcrumbs) +- [x] [Blog plugin: advanced settings] +- [x] [Blog plugin: author profiles] +- [x] [Blog plugin: pinned posts] +- [x] [Instant prefetching] + + [Optimize plugin]: ../plugins/optimize.md + [Navigation path]: ../setup/setting-up-navigation.md#navigation-path + [Blog plugin: advanced settings]: ../setup/setting-up-a-blog.md#advanced-settings + [Blog plugin: author profiles]: ../setup/setting-up-a-blog.md#adding-author-profiles + [Blog plugin: pinned posts]: ../setup/setting-up-a-blog.md#pinning-a-post + [Instant prefetching]: ../setup/setting-up-navigation.md#instant-prefetching + +#### $ 20,000 – Jalapeño + +- [x] [Typeset plugin] +- [x] [Footnote tooltips] +- [x] [Privacy plugin: advanced settings] +- [x] [Privacy plugin: external links] +- [ ] to be announced +- [ ] to be announced + + [Typeset plugin]: ../plugins/typeset.md + [Footnote tooltips]: ../reference/footnotes.md#footnote-tooltips + [Privacy plugin: external links]: ../plugins/privacy.md#external-links + [Privacy plugin: advanced settings]: ../setup/ensuring-data-privacy.md#advanced-settings + +#### $ 22,000 – Habanero Orange + +- [x] [Instant previews] +- [x] [Social plugin: custom layouts] +- [x] [Social plugin: background images] +- [x] [Code range selection] +- [x] [Code annotations: custom selectors] +- [x] [Stay on page when switching languages] + + [Instant previews]: ../setup/setting-up-navigation.md#instant-previews + [Social plugin: custom layouts]: ../setup/setting-up-social-cards.md#customization + [Social plugin: background images]: ../plugins/social.md#option.background_image + [Code range selection]: ../reference/code-blocks.md#code-selection-button + [Code annotations: custom selectors]: ../reference/code-blocks.md#custom-selectors + [Stay on page when switching languages]: ../setup/changing-the-language.md#stay-on-page + +#### $ 24,000 – Blockpaprika + +- [x] [Projects plugin] +- [x] [Tags plugin: nested tags] +- [x] [Tags plugin: shadow tags] +- [x] [Tags plugin: advanced settings] +- [ ] to be announced +- [ ] to be announced + + [Projects plugin]: ../plugins/projects.md + [Tags plugin: nested tags]: ../setup/setting-up-tags.md#nested-tags + [Tags plugin: shadow tags]: ../setup/setting-up-tags.md#shadow-tags + [Tags plugin: advanced settings]: ../setup/setting-up-tags.md#advanced-settings + +### Goals completed + +This section celebrates the milestones we’ve achieved thanks to our incredible +sponsors. Those features were once part of Material for MkDocs Insiders, and +therefore only available to our sponsors, and are now generally available to +be used by all users. + +#### $ 14,000 – Goat's Horn + +- [x] [Privacy plugin] +- [x] [Card grids] +- [x] [Tooltips] +- [x] [Content tabs: anchor links] +- [x] [Automatic light / dark mode] +- [x] [Document contributors] + + [Privacy plugin]: ../setup/ensuring-data-privacy.md#built-in-privacy-plugin + [Card grids]: ../reference/grids.md + [Tooltips]: ../reference/tooltips.md + [Content tabs: anchor links]: ../reference/content-tabs.md#anchor-links + [Automatic light / dark mode]: ../setup/changing-the-colors.md#automatic-light-dark-mode + [Document contributors]: ../setup/adding-a-git-repository.md#document-contributors + +#### $ 12,000 – Piri Piri + +- [x] [Blog plugin] +- [x] [Chinese search support] +- [x] [Annotations] +- [x] [Navigation icons] +- [x] [Navigation pruning] +- [x] [Navigation status] + + [Blog plugin]: ../setup/setting-up-a-blog.md + [Chinese search support]: ../blog/posts/chinese-search-support.md + [Annotations]: ../reference/annotations.md + [Navigation icons]: ../reference/index.md#setting-the-page-icon + [Navigation pruning]: ../setup/setting-up-navigation.md#navigation-pruning + [Navigation status]: ../reference/index.md#setting-the-page-status + +#### $ 10,000 – Carolina Reaper + +- [x] [Brand new search plugin] +- [x] [Rich search previews] +- [x] [Tokenizer with lookahead] +- [x] [Advanced search highlighting] +- [x] [Excluding content from search] +- [x] [Offline plugin] + + [Brand new search plugin]: ../blog/posts/search-better-faster-smaller.md + [Rich search previews]: ../blog/posts/search-better-faster-smaller.md#rich-search-previews + [Tokenizer with lookahead]: ../blog/posts/search-better-faster-smaller.md#tokenizer-lookahead + [Advanced search highlighting]: ../blog/posts/search-better-faster-smaller.md#accurate-highlighting + [Excluding content from search]: ../setup/setting-up-site-search.md#search-exclusion + [Offline plugin]: ../setup/building-for-offline-usage.md + +#### $ 8,000 – Scotch Bonnet + +- [x] [Social cards] +- [x] Code annotations: anchor links +- [x] [Code annotations: strip comments] +- [x] [Tag icons] +- [x] [Table of contents anchor following] +- [x] Sidebars automatically scroll to active item + + [Social cards]: ../setup/setting-up-social-cards.md + [Code annotations: strip comments]: ../reference/code-blocks.md#stripping-comments + [Tag icons]: ../setup/setting-up-tags.md#tag-icons-and-identifiers + [Table of contents anchor following]: ../setup/setting-up-navigation.md#anchor-following + +#### $ 7,000 – Royal Gold + +- [x] [Cookie consent] +- [x] [Was this page helpful?] +- [x] [Dismissable announcement bar] + + [Cookie consent]: ../setup/ensuring-data-privacy.md#cookie-consent + [Was this page helpful?]: ../setup/setting-up-site-analytics.md#was-this-page-helpful + [Dismissable announcement bar]: ../setup/setting-up-the-header.md#mark-as-read + +#### $ 6,000 – Trinidad Scorpion + +- [x] [Boosting pages in search] +- [x] [Custom admonition icons] +- [x] [Linking content tabs] + + [Boosting pages in search]: ../setup/setting-up-site-search.md#search-boosting + [Custom admonition icons]: ../reference/admonitions.md#admonition-icons + [Linking content tabs]: ../reference/content-tabs.md#linked-content-tabs + +#### $ 5,000 – Aji Panca + +- [x] [Mermaid.js integration] +- [x] Stay on page when switching versions +- [x] [Tags with search integration] + + [Mermaid.js integration]: ../reference/diagrams.md + [Tags with search integration]: ../setup/setting-up-tags.md + +#### $ 4,000 – Ghost Pepper + +- [x] [Anchor tracking] +- [x] [Code annotations] +- [x] [Version warning] + + [Anchor tracking]: ../setup/setting-up-navigation.md#anchor-tracking + [Code annotations]: ../reference/code-blocks.md#adding-annotations + [Version warning]: ../setup/setting-up-versioning.md#version-warning + +#### $ 3,000 – Caribbean Red + +- [x] [Sticky navigation tabs] +- [x] [Section index pages] +- [x] [Remove generator notice] + + [Sticky navigation tabs]: ../setup/setting-up-navigation.md#sticky-navigation-tabs + [Section index pages]: ../setup/setting-up-navigation.md#section-index-pages + [Remove generator notice]: ../setup/setting-up-the-footer.md#generator-notice + +#### $ 2,500 – Biquinho Vermelho + +- [x] [Search suggestions] +- [x] [Search highlighting] +- [x] [Search sharing] + + [Search suggestions]: ../setup/setting-up-site-search.md#search-suggestions + [Search highlighting]: ../setup/setting-up-site-search.md#search-highlighting + [Search sharing]: ../setup/setting-up-site-search.md#search-sharing + +#### $ 2,000 – Black Pearl + +- [x] Latest release tag +- [x] [Color palette toggle] +- [x] [Back-to-top button] + + [Color palette toggle]: ../setup/changing-the-colors.md#color-palette-toggle + [Back-to-top button]: ../setup/setting-up-navigation.md#back-to-top-button + +#### $ 1,500 – Bhut Jolokia + +- [x] [Admonition inline blocks] +- [x] [Site language selection] +- [x] [Versioning] + + [Admonition inline blocks]: ../reference/admonitions.md#inline-blocks + [Site language selection]: ../setup/changing-the-language.md#site-language-selector + [Versioning]: ../setup/setting-up-versioning.md#versioning + +#### $ 1,000 – Prairie Fire + +- [x] [Navigation sections] +- [x] [Navigation expansion] +- [x] [Hiding the sidebars] +- [x] [Table of contents in navigation] +- [x] [Header hides on scroll] + + [Navigation sections]: ../setup/setting-up-navigation.md#navigation-sections + [Navigation expansion]: ../setup/setting-up-navigation.md#navigation-expansion + [Hiding the sidebars]: ../setup/setting-up-navigation.md#hiding-the-sidebars + [Table of contents in navigation]: ../setup/setting-up-navigation.md#navigation-integration + [Header hides on scroll]: ../setup/setting-up-the-header.md#automatic-hiding + +#### $ 500 – Madame Jeanette + +- [x] Improved search result grouping +- [x] Improved search result relevance and scoring +- [x] Missing query terms in search results diff --git a/docs/insiders/faq/sponsoring.md b/docs/insiders/faq/sponsoring.md deleted file mode 100644 index 0bdcb61e186..00000000000 --- a/docs/insiders/faq/sponsoring.md +++ /dev/null @@ -1,585 +0,0 @@ -# Sponsoring FAQs - -Do you have questions about Material for MkDocs Insiders? We do our best to -answer all of your questions on this page. If you can't find your question -below, ask it on our [discussion board]! - - [discussion board]: https://github.com/squidfunk/mkdocs-material/discussions/new/chooses - -## General - -[__Why did we create Material for MkDocs Insiders?__](#insiders-edition){ #insiders-edition } - -So, here's the deal: Material for MkDocs began as a passion project, which we -made open-source to share freely with everyone. However, as the project's -popularity grew over the last few years, so did the demands of its maintenance -and overhead. Faced with the growing demands and the tough choice between -discontinuing our efforts or dedicating ourselves full-time, we chose to commit -ourselves fully to the project. - -To sustain this full-time commitment and to expand the team, we introduced -Material for MkDocs Insiders. This private Insiders repository, available -exclusively to our monthly sponsors, is where we first release the latest -advancements of Material for MkDocs. That way our sponsors get the -[premium features] in advance of all others users as a thank you for their -support. But here's the best part: once we achieve specific funding goals, these -advancements become available to the wider community. This model ensures ongoing -development and accessibility for all, keeping the project vibrant and -up-to-date. - -We communicate these [funding goals] and their progress openly, ensuring our -community is involved every step of the way. It's our way of making sure that -while we do need the support to keep going, everyone will eventually benefit -from the advancements made possible by our sponsors. - - [funding goals]: ../index.md/#funding - [premium features]: ../index.md/#whats-in-it-for-me - - -[__Why is the Insiders offered as a subscription model?__](#subscription-model){ #subscription-model } - -You might wonder why we opted for a subscription model for the Insiders edition -instead of a one-time purchase. Here's the thing: Material for MkDocs is in -constant evolution. Our work is never done because there's always something new -on the horizon – be it adapting to upstream dependency updates, keeping pace -with environment changes like browser updates, or bringing to life -the new features and improvements our users wish for. - -A one-time payment might seem appealing at first glance, but it's a bit like -buying a snapshot: great for a moment, but it doesn't stay current for long. -With a subscription, you're not just buying what's already been developed; -you're investing in what's coming next. You get all the future updates, bug -fixes, and new features as they roll out. This ongoing development is crucial -not just for keeping the project alive and kicking but for ensuring it -continues to meet your needs and expectations. - -This subscription model is what enables us to dedicate the necessary time and -resources to Material for MkDocs, ensuring its sustainability and growth. It's -about more than just maintaining the status quo; it's about pushing boundaries, -improving, and innovating. When we hit our funding goals through these monthly -subscriptions, we will roll out the Insiders features to the community edition. -That way, the whole community benefits from the advancements made possible by -our supporters. - -In essence, the subscription is a commitment to not just maintaining but -actively developing Material for MkDocs. It allows us to plan for the future -with confidence, knowing we have the backing to continue our work. This model -has made all the difference, enabling us to rely on our sponsors' ongoing -support and ensuring that Material for MkDocs remains a cutting-edge tool for -everyone. - -[__What features are included in the Insiders edition?__](#insiders-features){ #insiders-features } - -The Insiders edition includes more than 20 additional features. You can find an -[overview of these features] on our [Insiders page], which is updated when new -features are added and released. - - [Insiders page]: ../index.md - [overview of these features]: ../index.md#whats-in-it-for-me - -[__How often is the Insiders edition updated?__](#insiders-updates){ #insiders-updates } - -We try to keep our open issue count low, fixing known bugs quickly. Both our -repositories, the community and Insiders edition, are constantly updated with -bug fixes and new features. - -## Sponsorship - -[__Can I sponsor the project without a GitHub account?__](#sponsorship-account){ #sponsorship-account } - -No, you can't support Material for MkDocs if you don't have a GitHub account. -GitHub Sponsors handles all transactions and access management for us. Please -also note that the private Insiders repository is on GitHub, so in order to gain -access, you'll need to have a GitHub individual or bot account that can be added -as a collaborator. If your organization doesn't use GitHub or hosts its -repositories on other platforms, you can mirror the Insiders repository in your -environment once you have access. - -[__We are hosting our repository on Gitlab, can we also use Insiders?__](#github-alternatives){ #github-alternatives } - -Absolutely! 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 all transactions and -manage access to the private Insiders repository through GitHub. - -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 -Material for MkDocs Insiders. - -For any questions about integrating Material for MkDocs Insiders into your -projects, our [discussion board] is a valuable resource. 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. - - [mirror the repository in another location]: https://docs.github.com/en/repositories/creating-and-managing-repositories/duplicating-a-repository#mirroring-a-repository-in-another-location - -[__Which sponsoring tier should I choose?__](#sponsorship-tier){ #sponsorship-tier } - -The sponsoring tiers are divided into [non-commercial] and [commercial] tiers. If -you are an individual or organization using Material for MkDocs for private or -__non-commercial__ Open Source projects, you have two tiers to choose from, -depending on the number of sites you want to build. For companies using -Material for MkDocs, we offer three different __commercial__ tiers, from which -you can choose depending on your requirements. - -Also, please read what is considered [commercial] use. - - [commercial]: ../faq/sponsoring.md/#commercial-use - [non-commercial]: ../faq/sponsoring.md/#non-commercial-use - -[__Why are one-time sponsorships not granted access to Insiders?__](#sponsorship-one-time){ #sponsorship-one-time } - -Primarily due to technical reasons, that we're working on lifting in the future. -We use GitHub webhooks to determine our current active sponsors. When you create -or cancel your monthly subscription, GitHub sends events that we use to -automatically add and remove collaborators. - -Note that [$15] is the minimum amount to be granted access to Insiders. - - [$15]: https://github.com/sponsors/squidfunk/sponsorships?tier_id=210638 - -[__How are sponsorship contributions used?__](#sponsorship-support){ #sponsorship-support } - -It's vital to recognize that the total sponsorship amount doesn't directly -translate into the funds we have available for use. The way we allocate -sponsorship amounts is detailed as follows: - -1. __Taxes__: Since we provide a service to our sponsors, we're of course - legally obligated to pay sales tax. This requirement applies to all - sponsorship contributions, aligning us with standard business practices - as for the rest of the world. - -2. __Sponsorships__: A significant portion of our funding is redirected to - upstream projects. This cultivates collaboration and supports the broader - Open Source ecosystem. Those projects and their maintainers are essential - for the ongoing development of Material for MkDocs. - - [Explore our sponsorships](https://github.com/squidfunk?tab=sponsoring). - -3. __Funds__: We are in the process of forming a team devoted to Material for - MkDocs and are proactively compensating critical contributors. These - funds cover various aspects of the project, like the creation of new - features, bug resolution, support, and sponsor relations. - -[__Are there any limitations on the number of sponsors for a particular tier?__](#sponsorship-limitations){ #sponsorship-limitations } - -No, there are no limitations on the number of sponsors for any tier. You can -sponsor the project at any tier regardless of how many other sponsors are -already there. - -## Payment & billing - -[__Is there a trial period for the Insiders edition?__](#insiders-trial){ #insiders-trial } - -No, we do not offer a trial period for the Insiders edition. However, if you're -a company and are considering sponsoring on the [commercial] tier, but want to -first give the Insiders edition a try, you can sponsor on the [$15] tier with a -personal account for [non-commercial] evaluation purposes. - -Additionally, our subscription model allows you to cancel your sponsorship -anytime. If you decide to cancel, your sponsorship will remain active until -the end of your billing cycle. - -[__What payment options do you accept?__](#insiders-payment){ #insiders-payment } - -We manage all our transactions and sponsorships through [GitHub Sponsors]. To -become a sponsor of Material for MkDocs on GitHub, visit [our sponsors' page]. -On there, you can choose from five different sponsorship tiers and pay by credit -card. Please note that as of the beginning of 2023, -[GitHub no longer supports PayPal] payments. - -If you're a company and need assistance choosing the right payment method, -please don't hesitate to reach out to sponsors@squidfunk.com. - - [GitHub Sponsors]: https://github.com/sponsors - [GitHub no longer supports PayPal]: https://github.blog/changelog/2023-01-23-github-sponsors-will-stop-supporting-paypal/ - [our sponsors' page]: https://github.com/sponsors/squidfunk/ - -[__Are discounts available for the Insiders edition, such as student discounts?__](#insiders-discounts){ #insiders-discounts } - -Unfortunately, we are not able to offer any discounts for the Material for -MkDocs Insiders program. To ensure that everyone can afford the Insiders program -and keep the barrier as low as possible, we have set prices as low as [$15] a -month for [non-commercial] use. - -[__Do you offer free access to Insiders for Open Source projects?__](#insiders-open-source){ #insiders-open-source } - -No, we do not offer free access to our Material for MkDocs Insiders edition. -We understand that non-profit organizations may have limited budgets and may -need to prioritize their spending on other projects or organizations. However, -it's important to note that Material for MkDocs is maintained by a small team, -investing a lot of time and resources into constantly improving this project. -Material for MkDocs and its core features are free to the community through our -Open Source model. Therefore, Material for MkDocs itself is already free. - -However, we do offer an affordable sponsorship tier starting at [$15] a month, -which is meant for individuals and non-profit organizations using Material for -MkDocs to build 1-2 sites for [non-commercial] purposes. This tier provides access -to all new features, benefiting you from our ongoing development efforts. - -[__Is Insiders free for those who contribute to this project?__](#insiders-contributors){ #insiders-contributors } - -Thank you for your interest in contributing to Material for MkDocs! We value -every contribution, but it's important to distinguish between different types of -contributions. While minor edits such as typo corrections or adding new -languages are appreciated, they demand significant review efforts that exceed -the scope of such contributions. Consequently, free access to the Insiders -edition is exclusively offered to our [community experts]. - -If you're passionate about making a significant impact, we encourage you to -explore our [community experts] program. This program is designed for -experienced users eager to share their expertise on our [discussion board]. Our -discussion board facilitates the exchange of insights on workarounds, setups, -and features and addresses queries from users at all levels of experience. As a -community expert you become an integral part of our project by actively -assisting users and addressing their inquiries. This allows our team to focus -more on enhancing and developing new features – benefiting the entire community. - -In acknowledgment of such valuable contributions, active [community experts] are -granted free access to the Insiders edition. This presents a fantastic -opportunity for you to make meaningful contributions while enjoying the perks of -the Insiders edition. - - [community experts]: ../community-experts-program/index.md - -[__Can I purchase the Insiders edition with a one-time donation?__](#one-time-donation){ #one-time-donation } - -One-time donations, while appreciated, cannot support the ongoing development of -Material for MkDocs as subscriptions do. Our project's growth relies on steady -support from subscriptions to fund new features, updates, and maintenance. -Therefore, the Insiders version is not available through a one-time donation. - -If monthly payments do not work for you or your company, you can adjust your -GitHub account's [billing cycle] to annual instead of monthly and sponsor at the -appropriate tier. - -[billing cycle]: ../insiders/faq/sponsoring.md/#insiders-billing-cycle - -[__How can I set my billing to monthly or yearly?__](#insiders-billing-cycle){ #insiders-billing-cycle } - -Before you sponsor Material for MkDocs on one of our sponsoring tiers, you can -change your [billing cycle] to either monthly or yearly, according to your -preference. Your [billing cycle] is a setting at the account level on GitHub, -which you can easily modify in your account settings. When selecting one of our -sponsoring tiers, this adjustment will automatically categorize you as a monthly -or yearly sponsor. - -If you find it challenging to make this change in your account, a practical -workaround is to create a dedicated GitHub bot account where you set the billing -cycle to yearly and use it specifically for your sponsorship contributions. This -is a strategy some of our sponsors have successfully implemented. For any -difficulties or further inquiries, please don’t hesitate to contact us at -sponsors@squidfunk.com for support. - - [billing cycle]: https://docs.github.com/en/github/setting-up-and-managing-billing-and-payments-on-github/changing-the-duration-of-your-billing-cycle - -[__Can I get an invoice for my sponsorship payment?__](#insiders-invoice){ #insiders-invoice} - -Since [GitHub Sponsors] manages all transactions on our behalf, GitHub Sponsors -is considered your supplier, not us. As part of their process, GitHub Sponsors -automatically sends you a payment receipt via email for each billing cycle. It's -important to note that this document is a receipt, not an invoice. If you -require an invoice for your records, please contact us at sponsors@squidfunk.com -before initiating your sponsorship. - - [GitHub Sponsors]: https://github.com/sponsors/squidfunk/ - -[__Can I switch between different sponsoring tiers?__](#insiders-switch-tiers){ #insiders-switch-tiers } - -Yes, you can switch between different sponsoring tiers at any time. Simply go -to the [GitHub Sponsors] page and change your sponsoring tier. Once you make -that change, you will immediately change to the new tier. - -If you change to a higher tier, the amount will be prorated according to your -billing cycle. - -[__Can I sponsor the project for a specific feature or development goal?__](#insiders-goals){ #insiders-goals } - -While sponsoring specific goals directly is not possible, our sponsoring goals -are connected to specific features or development goals aligned with the -project's roadmap. You can find an [overview of these sponsoring goals] and their -associated features on our website. Insider users have early access to all -already developed features, including those associated with higher funding goals -that will be reached at a later stage. If you're interested in accessing these -features, becoming a sponsor is the way to go. If you have a feature in mind -that you would like to see on the list, we encourage you to -[initiate a new discussion] to evaluate it with others. - - [overview of these sponsoring goals]: ../index.md#goals - [initiate a new discussion]: https://github.com/squidfunk/mkdocs-material/discussions - -[__What happens if I reach my sponsoring limit for my current tier?__](#insiders-limit){ #insiders-limit } - -If you extend the number of sites that are in your current sponsoring limit, -please [upgrade your sponsorship] to a higher tier to continue using the -Insiders edition and build more sites. The change will be effective immediately. - - [upgrade your sponsorship]: https://docs.github.com/en/billing/managing-billing-for-github-sponsors/upgrading-a-sponsorship - -[__Do you offer refunds for sponsoring payments?__](#insiders-refunds){ #insiders-refunds } - -Unfortunately, we cannot offer any refund for sponsorship payments. -[GitHub Sponsors] manages all sponsoring transactions. Because of that, we do -not have any insights into the details of the funds and cannot access them. If -you have any payment issues, please get in touch with the GitHub Sponsors -support team, as they can help you. - -## Access management - -[__How do I gain access to the private Insiders repository?__](#access-account){ #access-account } - -If you sponsored with your __individual account__, you should have received an -email invitation to the private Material for MkDocs Insiders repository right -after you initiated your sponsorship. Simply accept the invitation within seven -days to gain access. - -If you sponsored using an __organization account__, please note we need -an individual account that we can list as a collaborator of the private Insiders -repository. After you initiate your sponsorship, please email us at -sponsors@squidfunk.com with the name of the individual or bot account. Once you -provide us with this information, we will add the account as a collaborator, and -after you accept the invitation, you will gain access to the repository. - -If you have yet to receive the email or the invitation link has expired, please -contact us, the maintainers, at sponsors@squidfunk.com. We're working on a -solution that will allow you to manage collaborator status yourself. - -[__Why can't our whole organization get access to Insiders?__](#access-organization){ #access-organization } - -Currently, it is not possible to grant access to an organizational account, as -GitHub only allows for adding individual user accounts. We are working on a -solution ourselves to simplify access for organizations. For now, to ensure that -access is not tied to a particular individual, we recommend creating a bot -account, i.e., a GitHub account that does not belong to a specific individual -but is listed as the owner of the organizational account and using this account -for sponsorship. - -[__Do I need to fork the repository to use it?__](#access-fork){ #access-fork } - -It depends. If you are using the Insiders edition as an individual, you can work -directly with the private repository, as you do not need to share the Insiders -features with others. If you are working with a team, it is best to create a -private [fork] using the individual account you listed as a collaborator of -Material for MkDocs to grant access to all members of your organization to -your fork. - -[__Can I share my Insiders access with others?__](#access-share){ #access-share } - -At the moment, it is not possible to directly share your collaborator status -for the private Insiders repository with other accounts. However, if you are -working with a team and would like them to access Insiders, you can share the -Insiders repository by utilizing options such as [cloning], [forking], or -[mirroring]. By doing so, you can start collaborating with your team members on -the new repository you have shared. This way, you can collectively benefit -from the Insiders features and work together on the project. - - [cloning]: https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository - [forking]: https://docs.github.com/en/get-started/quickstart/fork-a-repo - [mirroring]: https://docs.github.com/en/repositories/creating-and-managing-repositories/duplicating-a-repository - - -## Runtime & cancellation - -[__How long is my sponsorship valid?__](#sponsorship-runtime){ #sponsorship-runtime } - -Your sponsorship is valid for as long as your monthly or yearly subscription -is valid. If you choose to cancel your sponsorship, you will lose access to -the Insiders edition once your cancellation is active and will be automatically -removed by GitHub as a collaborator from the private repository. - -[__How do I cancel my sponsorship?__](#sponsorship-cancellation){ #sponsorship-cancellation } - -To cancel your sponsorship, follow the [step-by-step guide] provided by GitHub. -If you sponsored using an organizational account, please ensure that you cancel -your sponsorship using the same organizational account rather than your -individual account. - - [step-by-step guide]: https://docs.github.com/en/billing/managing-billing-for-github-sponsors/downgrading-a-sponsorship - -[__What happens when I cancel my sponsorship?__](#sponsorship-cancellation-effective){ #sponsorship-cancellation-effective } - -If you choose to cancel your subscription to Insiders, you will be -automatically removed by GitHub as a collaborator on the day your cancellation is -effective. From that day on, you will no longer receive future updates. However, -you are __welcome to continue using the latest version__ that was available to -you at the time of your cancellation for as long as you like. - -Please note that [GitHub deletes private forks], so you may want to take steps -to ensure that you have a backup of the software if necessary and use the -locally installed version. - - [GitHub deletes private forks]: https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository#deleting-forks-of-private-repositories - -## Licensing - -[__What constitutes commercial use of the Insiders edition?__](#commercial-use){ #commercial-use } - -Commercial use refers to any use of the software for a business or for-profit -purpose. This includes any use by a corporation or other organization, whether -or not they generate revenue directly from the software. We offer different -pricing tiers for commercial use, each tailored to the needs of different -businesses. It's important to note that internal use of the software within your -organization is also considered commercial use, as with all commercial software. - -[__What constitutes non-commercial use of the Insiders edition?__](#non-commercial-use){ #non-commercial-use } - -[Non-commercial] use of our Material for MkDocs refers to private use. This -includes individuals using the Insiders edition for private or purely -non-commercial Open Source projects. We offer two different tiers for -non-commercial use, depending on the number of sites you want to build. - -[__What is your fair use policy?__](#fair-use-policy){ #fair-use-policy } - -Our fair use policy includes the following guidelines: - -- Please refrain from __distributing the source code__ of Insiders. While you -may use the software for public, private, or commercial projects and may -privately [fork] or [mirror] it, we ask that you keep the source code private. This -is important to our sponsorware strategy, which helps us fund ongoing -development and support of the software. If this guidelines is violated, -everybody loses, as it will reduce the time of us maintainers we can set aside -to push this project forward. - -- As our sponsoring tiers are based on the number of sites you want to build, -please make sure to [upgrade your sponsorship] once your current sponsoring tier -limit has been reached. - -[__Does the Insiders edition have a different license?__](#insiders-license){ #insiders-license } - -No. 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]. - - [MIT license]: ../../license.md - -[__Can outside collaborators build and run the documentation locally without access to Insiders?__](#insiders-outside-collaborators){ #insiders-outside-collaborators } - -Yes. Insiders is compatible with Material for MkDocs. Almost all new features -and configuration options are either backward-compatible or implemented behind -feature flags. When working with outside collaborators, changing the general -appearance of your site should be optional. Most Insiders features enhance the -overall experience, e.g., by adding icons to pages or providing a feedback -widget. While these features add value for your site's users, they should be -optional for previewing when making changes to content. Currently, the only -content-related feature in Insiders that non-Insiders users can't properly -preview are [Card grids]. - -This means that outside collaborators can build the documentation locally with -Material for MkDocs, and when they push their changes, your CI pipeline will -build it with Insiders. When using built-in plugins exclusive to Insiders, it's -recommended to split configuration into a base `mkdocs.yml` and one with plugin -overrides via [configuration inheritance]. - -See the [getting started guide] for more information. - - [configuration inheritance]: https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance - [getting started guide]: ../getting-started.md - [Card grids]: ../../reference/grids.md?h=grids#using-card-grids - -## Support - -[__How can I contact support if I have questions about becoming a sponsor?__ ](#support-contact){ #support-contact } - -If you have any questions and would like to contact us before starting your -sponsorship, we are happy to answer all your non-technical questions about the -Insiders program via email at sponsors@squidfunk.com. - -All technical questions should be asked openly on our [discussion board]. - - [discussion board]: https://github.com/squidfunk/mkdocs-material/discussions - -[__Is additional support available for Material for MkDocs Insiders users?__](#support-additional){ #support-additional } - -Yes, we provide non-technical support related to sponsoring at -sponsors@squidfunk.com. For technical questions, please submit an issue openly -on our [issue tracker] or start a discussion on our [discussion board]. Issues -and discussions from our organizational sponsors, sponsoring on -__The Organization__ tier or higher will be prioritized.[^1] - - [^1]: - Priority support means we will prioritize your issue, meaning we will look - into it and do our best to solve your issue asap. However, the prioritized bug - support does not mean that we can solve your issue before any others since - some issues might take more time to solve. - - [issue tracker]: https://github.com/squidfunk/mkdocs-material/issues - -[__How can I display my logo on the list of premium sponsors?__](#sponsorship-logo-placement){ #sponsorship-logo-placement } - -If your sponsorship tier includes logo placement, and you would like us to -display your logo in the [list of premium sponsors] and have it linked to your -site, please contact us via mail. Simply send us a horizontal SVG or PNG version -of your logo making sure it displays the name of your company and the logo to -sponsors@squidfunk.com. - - [list of premium sponsors]: https://github.com/squidfunk/mkdocs-material#user-content-premium-sponsors - -[__Is logo placement optional?__](#sponsorship-logo-placement-optional){ #sponsorship-logo-placement-optional } - -Yes, all of our commercial benefits, such as logo placement and backlinks, are -optional and can be opted in or out at any time. You can keep your sponsorship -completely private. - -[__How can I report a bug in the Insiders edition?__](#insiders-bugs){ #insiders-bugs } - -If you encounter a bug in the Insiders edition, we kindly request that you -report it on our [issue tracker] in the public community repository. When -submitting the bug report, please ensure that you do not include any private -Insiders' source code, as we want to uphold our fair use policy. - -[__How can I report an issue in my customizations?__](#customizations-issues){ #customizations-issues } - -Please note, that we do not offer support for customizations as they vary -widely and are specific to individual cases. Our support is primarily focused on -assisting with our core features. When reporting an issue, please remove all -customizations to ensure effective problem diagnosis with a minimal reproduction -[.zip file], as described in our bug reporting guide. Our [built-in info plugin], -which is essential when creating a reproduction, will not function correctly -with customizations in place. For questions and issues with customizations, -please use our [discussion board] to engage with the community. - - [.zip file]: ../../guides/creating-a-reproduction.md - [built-in info plugin]: https://squidfunk.github.io/mkdocs-material/guides/creating-a-reproduction/#creating-a-zip-file - -## Privacy - -[__Will you sign an NDA for sponsorships?__](#nda){ #nda } - -Unfortunately, we cannot sign any NDA or vendor agreement form. As a small team -working on Material for MkDocs, we have limited resources and cannot review -and sign agreements. - -[__Will you fill out our companys forms?__](#forms){ #forms } - -To dedicate more time and resources to the development of our projects, we have -implemented measures to minimize administrative overhead for our small team. As -part of this approach, we have adopted GitHub Sponsors to efficiently handle all -transactions for us. Consequently, we have decided to introduce a setup fee for -any additional administrative tasks other than those handled by GitHub Sponsors -that require our attention and involve the completion of forms or adherence to -company processes when purchasing Material for MkDocs Insiders. If your purchase -department requires additional time and effort from our team, please be aware -that the setup fee will apply. For detailed information and specific inquiries, -please reach out to us at sponsors@squidfunk.com. - -[__Can I sponsor privately?__](#sponsorship-private){ #sponsorship-private } - -Yes, you can. GitHub offers the option to [set your sponsorship to private] when -you initiate your sponsorship. This means that your account will not appear in -sponsor-listings so there is no public affiliation with Material for MkDocs. -Only we know that you sponsored, but we will never disclose this information -without your written consent. - - [set your sponsorship to private]: https://docs.github.com/en/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship#managing-the-privacy-setting-for-your-sponsorship - [fork]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo - [mirror]: https://docs.github.com/en/repositories/creating-and-managing-repositories/duplicating-a-repository - -[__Are there any geographical restrictions on becoming a sponsor?__](#sponsorship-geo){ #sponsorship-geo } - -No, there are no geographical restrictions for becoming a sponsor. We welcome -sponsorships from individuals and organizations worldwide. As long as your -credit card is valid and accepted by GitHub you are eligible to become -a sponsor and support the project, regardless of your location. diff --git a/docs/insiders/how-to-sponsor.md b/docs/insiders/how-to-sponsor.md new file mode 100644 index 00000000000..b7b071696d9 --- /dev/null +++ b/docs/insiders/how-to-sponsor.md @@ -0,0 +1,114 @@ +# How to sponsor + +Becoming a sponsor for Material for MkDocs is a straightforward process through +@squidfunk's [GitHub Sponsors profile]. By supporting +the project with a monthly contribution of __$15 a month__ or more, you can sponsor +either via an [individual] or [organizational] GitHub account. + + [GitHub Sponsors profile]: https://github.com/sponsors/squidfunk + [individual]: access-management.md/#individuals + [organizational]: access-management.md/#organizations + +## Walkthrough + +Want to become a sponsor? We will guide you through the sponsoring process below +If you have additional questions, you can find detailed information about +[payment and billing], [access management], [runtime and cancellation], +[privacy], [license] and [support] on dedicated pages. + + [payment and billing]: payment-and-billing.md + [access management]: access-management.md + [runtime and cancellation]: runtime-and-cancellation.md + [privacy]: privacy.md + [license]: license.md + [support]: ../support.md + +### Sponsoring tier + +First, it's a good idea to explore [our sponsoring tiers], as each sponsoring +tier is designed to accommodate different levels of sponsors and includes +dedicated benefits. + +After reviewing the sponsoring tiers, it's time to choose one. Consider what you +want to achieve and keep your requirements in mind, e.g. the number of projects +you want to build or how many accounts you need. [Switching tiers] is possible +at any time. + +Choosing a tier will take you to GitHub's sponsorship confirmation page. + + [our sponsoring tiers]: sponsoring-tiers.md + [Switching tiers]: sponsoring-tiers.md/#switching-tiers + +### Sponsorship summary + +#### Payment and billing + +Next, GitHub will ask you to provide your billing information, which is required +to process your sponsorship payment. On this page, the _Sponsorship summary_ +section displays the (possibly prorated) amount due to initiate your sponsorship. +This amount is determined by your account's [billing cycle], which can be set to +a monthly or yearly interval. + + [billing cycle]: https://docs.github.com/en/github/setting-up-and-managing-billing-and-payments-on-github/changing-the-duration-of-your-billing-cycle + +Proceed to input your [payment information], specifically your credit card +details. Please make sure that the used credit card is valid and will remain +so for an extended period to help avoid any interruptions in your sponsorship. + + [payment information]: payment-and-billing.md + +#### Privacy + +On this page, you can also set the visibility of your sponsorship. You have the +option to keep your [sponsorship private or to make it public], which includes +listing your name or organization on the list of [our sponsors] and, for +organizations, the opportunity for [logo placement]. + + [sponsorship private or to make it public]: privacy.md + [our sponsors]: our-sponsors.md + [logo placement]: our-sponsors.md/#our-premium-sponsors + +#### News and updates + +Note that we rarely send out emails, and when we do, it's usually to inform you +about significant updates or changes to the project, so it's best to keep this +option enabled. To stay updated on the latest developments, you can check out +our [changelog]. + + [changelog]: ../changelog/index.md + +#### Tax information + +If you're sponsoring as an organization, it's essential to provide your country, +region and VAT number, so we can correctly attribute your sponsorship. This is +due to the fact that VAT is handled differently for individuals than for +organizations. + +#### Confirmation + +Before finalizing your sponsorship, take a moment to review all the details of +your sponsorship, including the selected tier, billing information, and payment +details. + +Then proceed to confirm your sponsorship by clicking the _Sponsor_ button. + +### Access management + +After completing the sponsorship process and your payment is successfully +processed, you will be all set to [gain access] to the private Material for +MkDocs Insiders repository. + + [gain access]: access-management.md + +--- + +__Ready to become a sponsor?__ + +[  Choose a sponsoring tier ][sponsoring-tiers]{ .md-button .md-button--primary .mdx-sponsorship-button } + + [sponsoring-tiers]: sponsoring-tiers.md + +If you still find yourself with more questions, feel free to [reach out to Kathi] +via mail at sponsors@squidfunk.com for additional support. + + [reach out to Kathi]: ../support.md/#sponsoring-support diff --git a/docs/insiders/index.md b/docs/insiders/index.md index e928011c4fd..6632f145f92 100644 --- a/docs/insiders/index.md +++ b/docs/insiders/index.md @@ -1,595 +1,233 @@ ---- -title: 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 it for you]! - - - - [Insiders]: #what-is-insiders - [what sponsorships achieve]: #what-sponsorships-achieve - [how to become a sponsor]: #how-to-become-a-sponsor - [what's in it for you]: #whats-in-it-for-me - [Material for MkDocs]: https://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. Almost[^1] [all new features][what's in it for you] -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. - - [^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. - -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 [__$15 a month__][how to become a sponsor].[^2] - - [^2]: - Note that $15 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. - - [Python Markdown Extensions]: https://facelessuser.github.io/pymdown-extensions/ - [funding goal]: #funding - -## 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] - - [^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. - -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]! - - [completed funding goals]: #goals-completed - [thanks to our awesome sponsors]: #how-to-become-a-sponsor - -
-
- -
- -
- -## What's in it for me? - -The moment you [become a sponsor][how to become a sponsor], you'll get __immediate -access to 26 additional features__ that you can __start using now__, and -which are currently exclusively available to sponsors: - -
- -- [x] [Blog plugin: pinned posts] :material-alert-decagram:{ .mdx-pulse title="Added on February 24, 2024" } -- [x] [Instant previews] :material-alert-decagram:{ .mdx-pulse title="Added on January 28, 2024" } -- [x] [Footnote tooltips] :material-alert-decagram:{ .mdx-pulse title="Added on January 24, 2024" } -- [x] [Tags plugin: advanced settings] -- [x] [Tags plugin: nested tags] -- [x] [Tags plugin: shadow tags] -- [x] [Stay on page when switching languages] -- [x] [Blog plugin: author profiles] -- [x] [Blog plugin: advanced settings] -- [x] [Projects plugin] -- [x] [Instant prefetching] -- [x] [Social plugin: custom layouts] -- [x] [Social plugin: background images] -- [x] [Code range selection] -- [x] [Code annotations: custom selectors] -- [x] [Privacy plugin: advanced settings] -- [x] [Optimize plugin] -- [x] [Navigation path] (Breadcrumbs) -- [x] [Typeset plugin] -- [x] [Privacy plugin: external links] -- [x] [Navigation subtitles] -- [x] [Tags plugin: allow list] + [custom sorting] -- [x] [Blog plugin: custom index pages] -- [x] [Blog plugin: related links] -- [x] [Meta plugin] -- [x] [Tags plugin: configurable listings] +If you want to get the best out of Material for MkDocs, Insiders is what you're +looking for – it's an exclusive version of Material for MkDocs that offers +additional features and enhancements. By becoming a sponsor, you get early access -
+Material for MkDocs Insiders offers an enhanced experience with early access to +exclusive features that aren't available in the community edition. Become a +sponsor and make use of these features directly! + +You’ve already seen the benefits of using Material for MkDocs; +imagine what more you can achieve with Insiders. Your sponsorship helps us +continue to innovate and improve, ensuring Material for MkDocs remains a +cutting-edge tool. Discover how your contributions make a difference. + +[  Choose a sponsoring tier ][sponsoring-tiers]{ .md-button .md-button--primary .mdx-sponsorship-button } + + [sponsoring-tiers]: sponsoring-tiers.md + +## Additional information + +Explore the following section to learn more about Material for MkDocs, why +you should sponsor us, what's in it for you, and who is sponsoring us. + +
+ +- :fontawesome-solid-circle-question:   + __Why sponsor us__ + + --- + + Learn how to support our goal of becoming the leading tool in documentation + + --- + + [:octicons-arrow-right-24: More information][Why sponsor us] + +- :material-gift:   + __What's in it for you__ + + --- + + Discover exclusive benefits and features available only to our monthly sponsors + + --- + + [:octicons-arrow-right-24: More infomation][What's in it for you] + +- :fontawesome-solid-people-group:   + __Who is sponsoring__ -New features are added every other week. Be sure to come back. - -## 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 __$15 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] - - [^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. - -[:octicons-heart-fill-24:{ .mdx-heart }   Join our awesome sponsors][squidfunk's sponsor profile]{ .md-button .md-button--primary .mdx-sponsorship-button } - -
- -
- -**Silver sponsors**: - -[![FastAPI]{ style="height: 120px" }](https://fastapi.tiangolo.com/){ target=_blank title="FastAPI" } -[![Trendpop]{ style="height: 120px" }](https://www.trendpop.com/){ target=_blank title="Trendpop" } -[![SailPoint]{ style="height: 120px" }](https://documentation.sailpoint.com/){ target=_blank title="SailPoint" } - -**Bronze sponsors**: - -[![Cirrus CI]](https://cirrus-ci.org/){ target=_blank title="Cirrus CI" } -[![Basler]](https://docs.baslerweb.com/){ target=_blank title="Basler" } -[![KX]](https://kx.com/){ target=_blank title="KX Systems" } -[![Prefect]](https://orion-docs.prefect.io/){ target=_blank title="Prefect" } -[![Zenoss]](https://zenoss.com/){ target=_blank title="Zenoss" } -[![Posit]](https://docs.posit.co){ target=_blank title="Posit" } -[![n8n]](https://n8n.io){ target=_blank title="n8n" } -[![Dogado]](https://www.dogado.de){ target=_blank title="Dogado" } -[![World Wide Technology]](https://wwt.com){ target=_blank title="World Wide Technology" } -[![Coda]](https://coda.io){ target=_blank title="Coda" } -[![Elastic]](https://elastic.co){ target=_blank title="Elastic" } -[![IP Fabric]](https://ipfabric.io/){ target=_blank title="IP Fabric" } -[![Apex.AI]](https://www.apex.ai/){ target=_blank title="Apex.AI" } -[![Jitterbit]](https://jitterbit.com/){ target=_blank title="Jitterbit" } -[![Sparkfun]](https://sparkfun.com/){ target=_blank title="Sparkfun Electronics" } -[![Eccenca]](https://eccenca.com/){ target=_blank title="Eccenca" } -[![Neptune]](https://neptune.ai/){ target=_blank title="Neptune" } -[![RackN]](https://rackn.com/){ target=_blank title="RackN" } -[![CivicActions]](https://civicactions.com/){ target=_blank title="CivicActions" } -[![bitcrowd]](https://bitcrowd.net/){ target=_blank title="bitcrowd" } -[![GetScreen.me]](https://getscreen.me/){ target=_blank title="GetScreen.me" } -[![BotCity]](https://botcity.dev/){ target=_blank title="BotCity" } -[![Springer Nature Technology]](https://www.springernature.com/gp){ target=_blank title="Springer Nature Technology" } -[![Kolena]](https://kolena.io/){ target=_blank title="Kolena" } -[![Evergiving]](https://www.evergiving.com/){ target=_blank title="Evergiving" } -[![Koor]](https://koor.tech/){ target=_blank title="Koor" } -[![Astral]](https://astral.sh/){ target=_blank title="Astral" } -[![Oikolab]](https://oikolab.com/){ target=_blank title="Oikolab" } -[![Bühler Group]](https://www.buhlergroup.com/){ target=_blank title="Bühler Group" } -[![Transformation Flow]](https://transformationflow.io/){ target=_blank title="Transformation Flow" } -[![3DR]](https://3dr.com/){ target=_blank title="3DR" } -[![Spotware]](https://spotware.com/){ target=_blank title="Spotware" } -[![Milford Assets]](https://milfordasset.com/){ target=_blank title="Milford Assets" } -[![Lechler]](https://www.lechler.com/){ target=_blank title="Lechler" } -[![Invers]](https://invers.com/){ target=_blank title="Invers" } -[![Maxar]](https://maxar.com/){ target=_blank title="Maxar" } -[![EquipmentShare]](https://www.equipmentshare.com/){ target=_blank title="EquipmentShare" } + --- + + Get to know our awesome sponsors, financially backing Material for MkDocs + + --- + + [:octicons-arrow-right-24: More infomation][Who is sponsoring]
- [FastAPI]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-fastapi.png - [Trendpop]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-trendpop.png - [Cirrus CI]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-cirrus-ci.png - [Basler]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-basler.png - [KX]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-kx.png - [Prefect]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-prefect.png - [Zenoss]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-zenoss.png - [Posit]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-posit.png - [n8n]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-n8n.png - [Dogado]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-dogado.png - [World Wide Technology]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-wwt.png - [Coda]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-coda.png - [Elastic]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-elastic.png - [IP Fabric]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-ip-fabric.png - [Apex.AI]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-apex-ai.png - [Jitterbit]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-jitterbit.png - [Sparkfun]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-sparkfun.png - [Eccenca]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-eccenca.png - [Neptune]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-neptune-ai.png - [Cash App]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-cashapp.png - [RackN]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-rackn.png - [CivicActions]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-civic-actions.png - [bitcrowd]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-bitcrowd.png - [GetScreen.me]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-getscreenme.png - [BotCity]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-botcity.png - [Springer Nature Technology]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-sn-technology.png - [Kolena]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-kolena.png - [Evergiving]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-evergiving.png - [Koor]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-koor.png - [Astral]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-astral.png - [Oikolab]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-oikolab.png - [Bühler Group]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-buhler.png - [Transformation Flow]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-transformationflow.png - [3DR]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-3dr.png - [Spotware]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-spotware.png - [Milford Assets]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-milford.png - [Lechler]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-lechler.png - [SailPoint]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-sailpoint.png - [Invers]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-invers.png - [Maxar]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-maxar.png - [EquipmentShare]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-equipmentshare.png - -
- -