mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2026-03-31 06:24:07 -04:00
Removed documentation on sponsoring
This commit is contained in:
squidfunk
BIN
.github/assets/sponsors/sponsor-maxar.png
vendored
BIN
.github/assets/sponsors/sponsor-maxar.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 4.9 KiB |
BIN
.github/assets/sponsors/sponsor-vantor.png
vendored
Normal file
BIN
.github/assets/sponsors/sponsor-vantor.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 10 KiB |
@@ -164,8 +164,8 @@
|
|||||||
<a href="https://invers.com/" target=_blank><img
|
<a href="https://invers.com/" target=_blank><img
|
||||||
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-invers.png" height="58"
|
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-invers.png" height="58"
|
||||||
/></a>
|
/></a>
|
||||||
<a href="https://maxar.com/" target=_blank><img
|
<a href="https://vantor.com/" target=_blank><img
|
||||||
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-maxar.png" height="58"
|
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-vantor.png" height="58"
|
||||||
/></a>
|
/></a>
|
||||||
<a href="https://www.equipmentshare.com/" target=_blank><img
|
<a href="https://www.equipmentshare.com/" target=_blank><img
|
||||||
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-equipmentshare.png" height="58"
|
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-equipmentshare.png" height="58"
|
||||||
|
|||||||
@@ -10,7 +10,6 @@ categories:
|
|||||||
links:
|
links:
|
||||||
- blog/posts/search-better-faster-smaller.md
|
- blog/posts/search-better-faster-smaller.md
|
||||||
- plugins/search.md#segmentation
|
- plugins/search.md#segmentation
|
||||||
- insiders/how-to-sponsor.md
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Chinese search support – 中文搜索支持
|
# Chinese search support – 中文搜索支持
|
||||||
|
|||||||
@@ -9,7 +9,6 @@ categories:
|
|||||||
links:
|
links:
|
||||||
- blog/posts/search-better-faster-smaller.md
|
- blog/posts/search-better-faster-smaller.md
|
||||||
- setup/setting-up-site-search.md#search-exclusion
|
- setup/setting-up-site-search.md#search-exclusion
|
||||||
- insiders/how-to-sponsor.md
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Excluding content from search
|
# Excluding content from search
|
||||||
|
|||||||
@@ -10,7 +10,6 @@ categories:
|
|||||||
- Performance
|
- Performance
|
||||||
links:
|
links:
|
||||||
- plugins/search.md
|
- plugins/search.md
|
||||||
- insiders/how-to-sponsor.md
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Search: better, faster, smaller
|
# Search: better, faster, smaller
|
||||||
|
|||||||
@@ -208,13 +208,11 @@ $50,000. Compared to last year, __revenue from funding has increased by 617%__
|
|||||||
[Funding]: the-past-present-and-future/funding.png
|
[Funding]: the-past-present-and-future/funding.png
|
||||||
|
|
||||||
I'm solely providing these numbers to fulfill the transparency pledge I'm giving
|
I'm solely providing these numbers to fulfill the transparency pledge I'm giving
|
||||||
to my [awesome sponsors], and to show that it's possible to make existing Open
|
to my awesome sponsors, and to show that it's possible to make existing Open
|
||||||
Source projects sustainable by following a well-designed release strategy.
|
Source projects sustainable by following a well-designed release strategy.
|
||||||
|
|
||||||
You can learn about the strategy in the [Insiders] guide.
|
You can learn about the strategy in the [Insiders] guide.
|
||||||
|
|
||||||
[awesome sponsors]: ../../insiders/how-to-sponsor.md
|
|
||||||
|
|
||||||
## 2022
|
## 2022
|
||||||
|
|
||||||
Standing at the verge of the next year, it's safe to say that the project will
|
Standing at the verge of the next year, it's safe to say that the project will
|
||||||
|
|||||||
@@ -195,9 +195,7 @@ These experiences led us to prioritize enhancing our search capabilities before
|
|||||||
|
|
||||||
While we navigate the challenges and explore the opportunities of this project, we consider it essential to demonstrate how we're building a solid foundation for its continued growth and success. Please consider this an overview rather than a formal roadmap — our detailed plans are in the works. The goals we've highlighted represent the most impactful areas we aim to address.
|
While we navigate the challenges and explore the opportunities of this project, we consider it essential to demonstrate how we're building a solid foundation for its continued growth and success. Please consider this an overview rather than a formal roadmap — our detailed plans are in the works. The goals we've highlighted represent the most impactful areas we aim to address.
|
||||||
|
|
||||||
Thanks to the generous support from our sponsors, we're fortunate to be assembling a team capable of dedicating significant time and expertise to this endeavor. This newfound capacity allows us to delve deeper into core development while also engaging more comprehensively with our user community. A special mention goes to @kamilkrzyskow, one of our invaluable [community experts], who has been essential in supporting users and fostering discussions on our platform.
|
Thanks to the generous support from our sponsors, we're fortunate to be assembling a team capable of dedicating significant time and expertise to this endeavor. This newfound capacity allows us to delve deeper into core development while also engaging more comprehensively with our user community. A special mention goes to @kamilkrzyskow, one of our invaluable community experts, who has been essential in supporting users and fostering discussions on our platform.
|
||||||
|
|
||||||
[community experts]: ../../insiders/community-experts-program/index.md
|
|
||||||
|
|
||||||
With the team's support, @squidfunk can concentrate on the heart of development, while we have begun investing in user research. This effort is helping us understand how organizations and individuals interact with our tools, guiding the project's future direction based on real feedback from numerous conversations with users and companies.
|
With the team's support, @squidfunk can concentrate on the heart of development, while we have begun investing in user research. This effort is helping us understand how organizations and individuals interact with our tools, guiding the project's future direction based on real feedback from numerous conversations with users and companies.
|
||||||
|
|
||||||
|
|||||||
@@ -1,204 +0,0 @@
|
|||||||
# 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]: ../plugins/index.md
|
|
||||||
[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
|
|
||||||
@@ -1,339 +0,0 @@
|
|||||||
# 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 20 additional features. New
|
|
||||||
features are added regularly, so be sure to check back regularly to stay
|
|
||||||
updated.
|
|
||||||
|
|
||||||
<div class="mdx-columns" markdown>
|
|
||||||
|
|
||||||
- [x] [Blog plugin: pinned posts]
|
|
||||||
- [x] [Instant previews]
|
|
||||||
- [x] [Footnote tooltips]
|
|
||||||
- [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]
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
## 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 <span class="mdx-sponsorship-count" data-mdx-component="sponsorship-count"></span>][sponsoring tiers]{ .md-button .md-button--primary .mdx-sponsorship-button }
|
|
||||||
|
|
||||||
[sponsoring tiers]: sponsoring-tiers.md#commercial-use
|
|
||||||
|
|
||||||
<div data-mdx-component="sponsorship"></div>
|
|
||||||
|
|
||||||
## Funding <span class="mdx-sponsorship-total" data-mdx-component="sponsorship-total"></span>
|
|
||||||
|
|
||||||
### 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.
|
|
||||||
|
|
||||||
#### $ 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.
|
|
||||||
|
|
||||||
#### $ 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
|
|
||||||
|
|
||||||
#### $ 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
|
|
||||||
@@ -1,147 +0,0 @@
|
|||||||
---
|
|
||||||
title: Community Experts Program
|
|
||||||
---
|
|
||||||
|
|
||||||
# Calling for Community Experts
|
|
||||||
|
|
||||||
Interested in joining the Material for MkDocs team as a Community Expert?
|
|
||||||
We're on the lookout for individuals who are passionate about supporting our
|
|
||||||
awesome community. In return for your valuable contributions, time, and
|
|
||||||
insights, __you'll gain free access to the Insiders edition__.
|
|
||||||
|
|
||||||
## Why we need you
|
|
||||||
|
|
||||||
As our project and community continue to grow, so do the questions and needs of
|
|
||||||
our users on our discussion board. Our discussion board is a vital part of our
|
|
||||||
project, serving as a hub for our community to connect and a valuable knowledge
|
|
||||||
base to complement our documentation.
|
|
||||||
|
|
||||||
We're eager to keeping it well-maintained, organized, easy to search and address
|
|
||||||
all queries which is why we need extra hands to keep up with the demand.
|
|
||||||
|
|
||||||
That's why we're building a team of Community Experts!
|
|
||||||
|
|
||||||
## Your role
|
|
||||||
|
|
||||||
As a Community Expert, your role primarily involves active participation on
|
|
||||||
our [discussion board], where we'd expect you to be:
|
|
||||||
|
|
||||||
- Answering discussions to help users with their questions
|
|
||||||
- Providing guidance regarding implementations
|
|
||||||
- Sharing insights into customizations and workarounds
|
|
||||||
- Optimizing searchability by adjusting discussion titles with relevant keywords
|
|
||||||
|
|
||||||
## Your benefits
|
|
||||||
|
|
||||||
Here is a list of the benefits we offer to our Community Experts:
|
|
||||||
|
|
||||||
- __Free access to Material for MkDocs Insiders__ – Exclusive Access to all of
|
|
||||||
our Material for MkDocs Insiders features for _non-commercial use_.[^1]
|
|
||||||
|
|
||||||
- __Close communication with the team__ – Stay connected with us through various
|
|
||||||
channels, including calls and internal project management tools.
|
|
||||||
|
|
||||||
- __GitHub profile boost__ – Enhance your GitHub profile's visibility and
|
|
||||||
credibility as your activity increases, earning you valuable badges that can
|
|
||||||
enhance your credibility.
|
|
||||||
|
|
||||||
[^1]:
|
|
||||||
Access to Insiders is granted to your primary account, i.e., the account
|
|
||||||
with which you're contributing to the project. It cannot be transferred to
|
|
||||||
another account. Additionally, it cannot be used for commercial purposes.
|
|
||||||
|
|
||||||
## Your knowledge & skills
|
|
||||||
|
|
||||||
To be a successful Community Expert, your skills should include the following:
|
|
||||||
|
|
||||||
- __Material and MkDocs allrounder__ – You have an understanding of Material
|
|
||||||
for MkDocs and the MkDocs ecosystem, including many of its extensions and
|
|
||||||
plugins.
|
|
||||||
|
|
||||||
- __Great communicator__ – You enjoy helping others in a productive,
|
|
||||||
constructive and friendly manner and use inclusive and welcoming language.
|
|
||||||
|
|
||||||
- __Independent worker__ – You are self-motivated, stay up-to-date with
|
|
||||||
project developments, regularly check the discussion board, and respond to
|
|
||||||
notifications in reasonable time.
|
|
||||||
|
|
||||||
[discussion board]: https://github.com/squidfunk/mkdocs-material/discussions
|
|
||||||
[documentation]: https://squidfunk.github.io/mkdocs-material/
|
|
||||||
[contribution guides]: ../contributing/index.md
|
|
||||||
|
|
||||||
## Your time commitment
|
|
||||||
|
|
||||||
We don't require a fixed number of hours each week; instead, we ask for a
|
|
||||||
minimum of __five answered discussions per month[^2]__, which amounts to
|
|
||||||
slightly more than one per week. Your active interaction within the community is
|
|
||||||
highly valued.
|
|
||||||
|
|
||||||
To do this effectively, it's best to regularly check the discussion board to see
|
|
||||||
where you can offer help. The time you invest may vary depending on the
|
|
||||||
complexity of the topics and questions.
|
|
||||||
|
|
||||||
Upon joining, you'll receive access to the Insiders' edition for as long as you
|
|
||||||
continue to assist us. Access will be renewed every three months, allowing you
|
|
||||||
the flexibility to continue your contributions or take a break as needed.
|
|
||||||
|
|
||||||
[^2]:
|
|
||||||
An answered discussion is a collaborative interaction where knowledge and
|
|
||||||
expertise are shared, resulting in resolutions or clarifications that benefit
|
|
||||||
the user and our entire community. In essence, it embodies the spirit of
|
|
||||||
cooperation and support within our community, highlighting the power of
|
|
||||||
collective wisdom and the willingness to assist and uplift one another.
|
|
||||||
|
|
||||||
## Ready to get started?
|
|
||||||
|
|
||||||
Since we have a limited number of seats for these roles[^3], we would like to
|
|
||||||
get to know you before you become one of our Community Experts. Here's how to
|
|
||||||
get started:
|
|
||||||
|
|
||||||
[^3]:
|
|
||||||
Please note that we're currently limiting the number of seats on the
|
|
||||||
Community Experts program to three. We will update this page when we'll
|
|
||||||
expand the team, which is when we'll be accepting new applications.
|
|
||||||
|
|
||||||
### Step 1: Get in touch
|
|
||||||
|
|
||||||
Send us an email introducing yourself, sharing a bit about your background, and
|
|
||||||
include a link to your GitHub profile. Additionally, provide links to three
|
|
||||||
previous discussions you've answered on the discussion board, where you've
|
|
||||||
assisted another community member.
|
|
||||||
|
|
||||||
Please use the following email template to reach out to us at
|
|
||||||
community@squidfunk.com:
|
|
||||||
|
|
||||||
```
|
|
||||||
Subject: Community Expert
|
|
||||||
|
|
||||||
Intro: Tell us a bit about yourself.
|
|
||||||
- Name:
|
|
||||||
- Background:
|
|
||||||
- Profession:
|
|
||||||
- GitHub profile:
|
|
||||||
|
|
||||||
Answered discussions
|
|
||||||
- Link 1:
|
|
||||||
- Link 2:
|
|
||||||
- Link 3:
|
|
||||||
```
|
|
||||||
|
|
||||||
### Step 2: Evaluation
|
|
||||||
|
|
||||||
After receiving and reviewing your application, we will get in touch with you
|
|
||||||
to discuss everything you need to know to get started. If you get selected, we
|
|
||||||
will set you up as a collaborator and provide you immediate access to the
|
|
||||||
Insiders edition for three months.
|
|
||||||
|
|
||||||
### Step 3: Dive in
|
|
||||||
|
|
||||||
Let's get started! You can actively begin participating in five discussions per
|
|
||||||
month. We trust you to take the lead, and we won't do strict monitoring. Simply
|
|
||||||
ensure that you are consistently listed on the _Most Helpful_ list, located on
|
|
||||||
the discussion board's left side, under the categories.
|
|
||||||
---
|
|
||||||
|
|
||||||
__Ready to join us?__
|
|
||||||
|
|
||||||
Sounds good? Let's give it a try!
|
|
||||||
@@ -6,13 +6,11 @@ title: Getting started with Insiders
|
|||||||
|
|
||||||
Material for MkDocs Insiders is a compatible drop-in replacement for Material
|
Material for MkDocs Insiders is a compatible drop-in replacement for Material
|
||||||
for MkDocs, and can be installed similarly using [`pip`][pip],
|
for MkDocs, and can be installed similarly using [`pip`][pip],
|
||||||
[`docker`][docker] or [`git`][git]. Note that in order to access the Insiders
|
[`docker`][docker] or [`git`][git].
|
||||||
repository, you need to [become an eligible sponsor] of @squidfunk on GitHub.
|
|
||||||
|
|
||||||
[pip]: #with-pip
|
[pip]: #with-pip
|
||||||
[docker]: #with-docker
|
[docker]: #with-docker
|
||||||
[git]: #with-git
|
[git]: #with-git
|
||||||
[become an eligible sponsor]: how-to-sponsor.md
|
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
|
|||||||
@@ -1,114 +0,0 @@
|
|||||||
# 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/#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 <span class="mdx-sponsorship-count" data-mdx-component="sponsorship-count"></span>][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
|
|
||||||
@@ -1,227 +1,4 @@
|
|||||||
# Insiders
|
---
|
||||||
|
template: redirect.html
|
||||||
Material for MkDocs Insiders offers an enhanced experience with early access to
|
location: getting-started/
|
||||||
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.
|
|
||||||
|
|
||||||
[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.
|
|
||||||
|
|
||||||
<div class="grid cards" markdown>
|
|
||||||
|
|
||||||
- :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 information][What's in it for you]
|
|
||||||
|
|
||||||
- :fontawesome-solid-people-group:
|
|
||||||
__Who is sponsoring__
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Get to know our awesome sponsors, financially backing Material for MkDocs
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
[:octicons-arrow-right-24: More information][Who is sponsoring]
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
### Sponsoring guide
|
|
||||||
|
|
||||||
Learn how to become a sponsor of Material for MkDocs Insiders and start your
|
|
||||||
sponsorship journey by choosing the right tier for you:
|
|
||||||
|
|
||||||
<div class="grid cards" markdown>
|
|
||||||
|
|
||||||
|
|
||||||
- :material-animation-outline:
|
|
||||||
__Sponsoring tiers__
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Find the perfect monthly sponsoring tier that fits your needs and
|
|
||||||
requirements
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
[:octicons-arrow-right-24: More information][Sponsoring tiers]
|
|
||||||
|
|
||||||
- :octicons-heart-fill-24:{ .mdx-heart }
|
|
||||||
__How to sponsor__
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Follow our step-by-step guide on how to become a sponsor to get you started
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
[:octicons-arrow-right-24: More information][How to sponsor]
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
### Additional information
|
|
||||||
|
|
||||||
If you require additional and detailed information about payment, billing,
|
|
||||||
access management, and more, here is everything you need to know:
|
|
||||||
|
|
||||||
<div class="grid cards" markdown>
|
|
||||||
|
|
||||||
- :material-hand-coin:
|
|
||||||
__Payment and billing__
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
All the information you need about payment methods and billing cycles
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
[:octicons-arrow-right-24: More information][Payment and billing]
|
|
||||||
|
|
||||||
- :material-key-variant:
|
|
||||||
__Access management__
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Learn about access management to Insiders – for individuals and
|
|
||||||
organizations
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
[:octicons-arrow-right-24: More information][Access management]
|
|
||||||
|
|
||||||
- :material-clock-time-three:
|
|
||||||
__Runtime and cancellation__
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Receive information on the duration of your sponsorship and the cancellation
|
|
||||||
process
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
[:octicons-arrow-right-24: More information][Runtime and cancellation]
|
|
||||||
|
|
||||||
- :material-lock-open:
|
|
||||||
__Privacy__
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Our commitment to your privacy – learn assurances on valuing your privacy
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
[:octicons-arrow-right-24: More information][Privacy]
|
|
||||||
|
|
||||||
- :material-briefcase:
|
|
||||||
__License__
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Get details on the licensing of Material for MkDocs Insiders and its requirements
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
[:octicons-arrow-right-24: More information][License]
|
|
||||||
|
|
||||||
- :material-email:
|
|
||||||
__Support__
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Overview of our support options available, ensuring you get the information
|
|
||||||
you need
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
[:octicons-arrow-right-24: More information][Support]
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
### Using Insiders
|
|
||||||
|
|
||||||
Once you have become a sponsor, you can start using Material for MkDocs Insiders,
|
|
||||||
get all the information you need to get started:
|
|
||||||
|
|
||||||
<div class="grid cards" markdown>
|
|
||||||
|
|
||||||
- :material-download:
|
|
||||||
__Getting started__
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Step-by-step instructions on how to install Material for MkDocs Insiders
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
[:octicons-arrow-right-24: More information][Getting started]
|
|
||||||
|
|
||||||
- :octicons-versions-16:
|
|
||||||
__Changelog__
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Review the latest changes and additions to Material for MkDocs Insiders
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
[:octicons-arrow-right-24: More information][Changelog]
|
|
||||||
|
|
||||||
- :material-update:
|
|
||||||
__Upgrade__
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Stay updated with the latest changes and improvements in the Insiders
|
|
||||||
edition
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
[:octicons-arrow-right-24: More information][Upgrade]
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
[Why sponsor us]: why-sponsor-us.md
|
|
||||||
[What's in it for you]: benefits.md
|
|
||||||
[Who is sponsoring]: our-sponsors.md
|
|
||||||
[Sponsoring tiers]: sponsoring-tiers.md
|
|
||||||
[How to sponsor]: how-to-sponsor.md
|
|
||||||
[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
|
|
||||||
[Getting started]: getting-started.md
|
|
||||||
[Changelog]: ../changelog/index.md
|
|
||||||
[Upgrade]: upgrade.md
|
|
||||||
|
|
||||||
----
|
|
||||||
|
|
||||||
__We're looking forward to welcoming you as a sponsor!__
|
|
||||||
|
|||||||
@@ -1,67 +0,0 @@
|
|||||||
# License
|
|
||||||
|
|
||||||
Material for MkDocs Insiders is licensed under the [MIT license], the exact
|
|
||||||
same license used for the community edition. The MIT license is a permissive
|
|
||||||
license that allows commercial use, redistribution, and everything else as
|
|
||||||
long as the original authors are credited in source files.
|
|
||||||
|
|
||||||
The MIT license is the [most popular license] among all Open Source projects.
|
|
||||||
|
|
||||||
[MIT license]: https://opensource.org/license/mit
|
|
||||||
[most popular license]: https://opensource.org/blog/the-most-popular-licenses-for-each-language-2023
|
|
||||||
|
|
||||||
## MIT License
|
|
||||||
|
|
||||||
The MIT License gives you the freedom to work with the code with minimal
|
|
||||||
restrictions. When using Material for MkDocs Insiders or the community edition,
|
|
||||||
make sure to __include the copyright notice__ and avoid future liability claims.
|
|
||||||
Its appeal lies in its simplicity and clear terms, making it a go-to for
|
|
||||||
projects of any scale. Its popularity stems from its simplicity, clarity,
|
|
||||||
and development-friendly terms, making it suitable for all types of projects.
|
|
||||||
The MIT License ensures that anyone – individual or organization – can use
|
|
||||||
Material for MkDocs Insiders under the same conditions as the community edition.
|
|
||||||
|
|
||||||
### Advantages of MIT
|
|
||||||
|
|
||||||
The MIT License is favored for its balance between freedom and protection,
|
|
||||||
appealing to those who find GNU/GPL licenses too restrictive or advocate for
|
|
||||||
privatized software. Its broad wording supports both open community development
|
|
||||||
and the use of components in proprietary software.
|
|
||||||
|
|
||||||
### MIT in open source
|
|
||||||
|
|
||||||
Material for MkDocs stands out for being open source, developed by a small,
|
|
||||||
user-oriented team committed to delivering high-quality tools for the community.
|
|
||||||
Here’s what this means for you:
|
|
||||||
|
|
||||||
- __Independence from investors:__ Our focus is purely on developing the
|
|
||||||
project and guiding it without external pressures. This freedom means we’re all
|
|
||||||
about what’s best for the community and the project's future.
|
|
||||||
- __Freedom from vendor lock-in:__ Thanks to Open Source principles, you can use
|
|
||||||
Material for MkDocs without any strings attached. Customize or integrate it
|
|
||||||
into your projects without worrying about restrictions. Your docs belong to you,
|
|
||||||
and you are free to change the software at any time.
|
|
||||||
- __Ecosystem Development:__ Material for MkDocs is more than a tool; it's a
|
|
||||||
community-driven effort to build an ecosystem, which it already is. Through open
|
|
||||||
collaboration, we’re constantly adding new extensions, plugins, and integrations
|
|
||||||
to give you more tools at your disposal.
|
|
||||||
|
|
||||||
## Fair use policy
|
|
||||||
|
|
||||||
Our fair use policy is here to ensure the project continues to thrive, which is
|
|
||||||
why we request that our sponsors respect the following:
|
|
||||||
|
|
||||||
- __Source Code Distribution:__ Keeping our sponsorware model intact means we
|
|
||||||
count on you not to distribute the Insiders source code. While you're encouraged
|
|
||||||
to privately [fork], or [mirror] the private Insiders repository for your needs,
|
|
||||||
__keeping the source private__ is key. If this guideline is violated,
|
|
||||||
everybody loses, as it will reduce the time of us maintainers we could otherwise
|
|
||||||
set aside to push this project forward.
|
|
||||||
- __Sponsorship tiers:__ We base our sponsorship tiers on non-commercial or
|
|
||||||
commercial use and ask our sponsors to respect these requirements when
|
|
||||||
initiating a sponsorship. Additionally, we base our sponsoring tiers on the number
|
|
||||||
of sites you intend to build. Please upgrade your sponsorship accordingly to
|
|
||||||
support the project’s growth and ensure its continued development.
|
|
||||||
|
|
||||||
[fork]: access-management.md/#forking
|
|
||||||
[mirror]: access-management.md/#mirroring
|
|
||||||
@@ -1,137 +0,0 @@
|
|||||||
# Our sponsors
|
|
||||||
|
|
||||||
Starting in 2020, we have managed to build a community of a few hundred sponsors
|
|
||||||
that support us every month, for which we are immensely grateful. Without their
|
|
||||||
financial support, Material for MkDocs wouldn't be anywhere near where it is
|
|
||||||
today.
|
|
||||||
|
|
||||||
<div class="mdx-premium" markdown>
|
|
||||||
|
|
||||||
## Premium sponsors
|
|
||||||
|
|
||||||
### Gold sponsors
|
|
||||||
|
|
||||||
_Be our first gold sponsor!_
|
|
||||||
|
|
||||||
----
|
|
||||||
|
|
||||||
### 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" }
|
|
||||||
[![Future]{ style="height: 120px" }](https://futureplc.com/){ target=_blank title="Future" }
|
|
||||||
[![SIEMENS]{ style="height: 120px" }](https://opensource.siemens.com/){ target=_blank title="SIEMENS" }
|
|
||||||
|
|
||||||
----
|
|
||||||
|
|
||||||
### 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" }
|
|
||||||
[![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" }
|
|
||||||
[![GetScreen.me]](https://getscreen.me/){ target=_blank title="GetScreen.me" }
|
|
||||||
[![BotCity]](https://botcity.dev/){ target=_blank title="BotCity" }
|
|
||||||
[![Kolena]](https://kolena.io/){ target=_blank title="Kolena" }
|
|
||||||
[![Evergiving]](https://www.evergiving.com/){ target=_blank title="Evergiving" }
|
|
||||||
[![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" }
|
|
||||||
[![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" }
|
|
||||||
[![Hummingbot]](https://hummingbot.org/){ target=_blank title="Hummingbot" }
|
|
||||||
[![OctoPerf]](https://octoperf.com/){ target=_blank title="OctoPerf" }
|
|
||||||
[![Inter Comestibles]](https://intercomestibles.ch/){ target=_blank title="Inter Comestibles" }
|
|
||||||
[![Centara]](https://www.centara.com/){ target=_blank title="Centara" }
|
|
||||||
[![Pydantic Logfire]](https://pydantic.dev/logfire/){ target=_blank title="Pydantic Logfire" }
|
|
||||||
[![Vector Informatik]](https://www.vector.com/){ target=_blank title="Vector Informatik" }
|
|
||||||
[![Second]](https://second.tech/){ target=_blank title="Second" }
|
|
||||||
[![MVTec]](https://mvtec.com/){ target=_blank title="MVTec" }
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
[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
|
|
||||||
[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
|
|
||||||
[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
|
|
||||||
[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
|
|
||||||
[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
|
|
||||||
[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
|
|
||||||
[Hummingbot]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-hummingbot.png
|
|
||||||
[Future]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-future.svg
|
|
||||||
[SIEMENS]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-siemens.png
|
|
||||||
[OctoPerf]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-octoperf.png
|
|
||||||
[Inter Comestibles]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-intercomestibles.png
|
|
||||||
[Centara]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-centara.png
|
|
||||||
[Pydantic Logfire]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-logfire.png
|
|
||||||
[Vector Informatik]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-vector.png
|
|
||||||
[Second]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-second.png
|
|
||||||
[MVTec]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-mvtec.png
|
|
||||||
|
|
||||||
<hr />
|
|
||||||
|
|
||||||
[ :material-arrow-up-bold: Add yourself to the list <span class="mdx-sponsorship-count" data-mdx-component="sponsorship-count"></span>][sponsoring-tiers]{ .md-button .md-button--primary .mdx-sponsorship-button }
|
|
||||||
|
|
||||||
[sponsoring-tiers]: sponsoring-tiers.md
|
|
||||||
|
|
||||||
## All sponsors
|
|
||||||
|
|
||||||
<div class="mdx-sponsorship" data-mdx-component="sponsorship" hidden>
|
|
||||||
<div class="mdx-sponsorship__list"></div>
|
|
||||||
<small>
|
|
||||||
If you sponsor publicly, you're automatically added here with a link to
|
|
||||||
your profile and avatar to show your support for Material for MkDocs.
|
|
||||||
Alternatively, if you wish to keep your sponsorship private, you'll be a
|
|
||||||
silent +1. You can select visibility during checkout and change it
|
|
||||||
afterwards.
|
|
||||||
</small>
|
|
||||||
</div>
|
|
||||||
@@ -1,94 +0,0 @@
|
|||||||
# Payment and billing
|
|
||||||
|
|
||||||
Since we host our repositories on GitHub, including both the Material for MkDocs
|
|
||||||
community edition and the private Insiders edition, [GitHub Sponsors] is a
|
|
||||||
natural fit for handling all financial transactions, as well as for access
|
|
||||||
management to the Insiders repository.
|
|
||||||
|
|
||||||
Therefore, to become a sponsor of Material for MkDocs, a [GitHub account] is mandatory.
|
|
||||||
|
|
||||||
[GitHub Sponsors]: https://github.com/sponsors
|
|
||||||
[GitHub account]: https://docs.github.com/en/get-started/start-your-journey/creating-an-account-on-github
|
|
||||||
|
|
||||||
## Payment
|
|
||||||
|
|
||||||
GitHub Sponsors currently only accepts payments via credit card, as they
|
|
||||||
[removed support for PayPal] at the beginning of 2023. When
|
|
||||||
entering your credit card details, ensure that the card remains [valid over an
|
|
||||||
extended period] to prevent any disruptions to your sponsorship.
|
|
||||||
|
|
||||||
[valid over an extended period]: runtime-and-cancellation.md#automatic-cancellation
|
|
||||||
[removed support for PayPal]: https://github.blog/changelog/2023-01-23-github-sponsors-will-stop-supporting-paypal/
|
|
||||||
|
|
||||||
## Invoices
|
|
||||||
|
|
||||||
GitHub Sponsors automatically issues and send a payment receipt via email after
|
|
||||||
each billing cycle. These receipts serve as confirmation of payment rather than
|
|
||||||
formal invoices. As all transactions are managed by [GitHub Sponsors], GitHub is
|
|
||||||
your primary point of contact for payment and billing matters, not us.
|
|
||||||
|
|
||||||
If you need an official invoice from us for your records, please get in touch
|
|
||||||
with us at sponsors@squidfunk.com before initiating your sponsorship.
|
|
||||||
|
|
||||||
## Refunds
|
|
||||||
|
|
||||||
Our team does not have insights or access to details related to sponsorship
|
|
||||||
transactions of our sponsors, as GitHub does not provide us with this
|
|
||||||
information. For questions regarding payment issues or for more detailed
|
|
||||||
information about your sponsorship, please get in touch with the [GitHub
|
|
||||||
support] team.
|
|
||||||
|
|
||||||
[GitHub support]: https://support.github.com/
|
|
||||||
|
|
||||||
## Discounts
|
|
||||||
|
|
||||||
Unfortunately, we can't offer discounts. To ensure that everyone in our
|
|
||||||
community can afford to become a sponsor, we keep the barrier low and set
|
|
||||||
prices as low as possible, starting at [\$15 a month][15] for
|
|
||||||
[non-commercial use] and at [\$125 a month][125] for [commercial use].
|
|
||||||
|
|
||||||
[15]: https://github.com/sponsors/squidfunk/sponsorships?tier_id=210638
|
|
||||||
[125]: https://github.com/sponsors/squidfunk/sponsorships?tier_id=210643
|
|
||||||
[non-commercial use]: sponsoring-tiers.md/#non-commercial-use
|
|
||||||
[commercial use]: sponsoring-tiers.md/#commercial-use
|
|
||||||
|
|
||||||
## Free access
|
|
||||||
|
|
||||||
Free access to the Insiders edition is only granted exclusively to our [Community
|
|
||||||
Experts] and to selected members of the MkDocs ecosystem. Our Community Experts
|
|
||||||
program is designed to recognize and reward users who significantly contribute
|
|
||||||
to the community by sharing 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. All
|
|
||||||
communication is public and visible for the entire community, benefitting
|
|
||||||
everyone.
|
|
||||||
|
|
||||||
Community experts not only enrich our project but also enable our team to focus
|
|
||||||
on continuous improvement and the development of new features. Therefore, we are
|
|
||||||
happy to provide them with free access to the private Insiders repository and
|
|
||||||
encourage you to [join the team] as well!
|
|
||||||
|
|
||||||
[community experts]: community-experts-program/index.md
|
|
||||||
[discussion board]: https://github.com/squidfunk/mkdocs-material/discussions
|
|
||||||
[join the team]: community-experts-program/index.md/#ready-to-get-started
|
|
||||||
|
|
||||||
## Billing cycle
|
|
||||||
|
|
||||||
The [billing cycle] is an account-level setting on GitHub and is set to monthly
|
|
||||||
or yearly. It can be changed at any time, so you might want to check the setting
|
|
||||||
before sponsoring and change it either to monthly or yearly according to your
|
|
||||||
own or your organization's preferences.
|
|
||||||
|
|
||||||
If, for whatever reason, you cannot change your billing cycle, a practical
|
|
||||||
solution is to create a dedicated [GitHub bot account] where you set the billing
|
|
||||||
cycle accordingly and use it specifically for your sponsorship contributions.
|
|
||||||
This is a strategy many of our organizational sponsors have successfully
|
|
||||||
implemented.
|
|
||||||
|
|
||||||
If you experience any difficulties or have further questions before sponsoring,
|
|
||||||
please don't hesitate to contact us at sponsors@squidfunk.com for additional
|
|
||||||
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
|
|
||||||
[GitHub bot account]: https://docs.github.com/en/get-started/start-your-journey/creating-an-account-on-github
|
|
||||||
@@ -1,79 +0,0 @@
|
|||||||
# Privacy
|
|
||||||
|
|
||||||
Transparency is at the heart of our sponsorware model, which includes our
|
|
||||||
funding goals, the features we're working towards, and, importantly, the
|
|
||||||
acknowledgment of our sponsors. As a sponsor, you can support our project
|
|
||||||
either [publicly] or [privately], according to your preference.
|
|
||||||
|
|
||||||
[publicly]: #public-sponsors
|
|
||||||
[privately]: #private-sponsors
|
|
||||||
|
|
||||||
## Public sponsors
|
|
||||||
|
|
||||||
By default, GitHub lists all sponsorships publicly. To sponsor privately, you
|
|
||||||
must explicitly select this option. When sponsoring publicly, your GitHub
|
|
||||||
account will be listed as part of [our sponsors], @squidfunk's [sponsoring page],
|
|
||||||
and within the "sponsoring" section of your GitHub account.
|
|
||||||
|
|
||||||
[our sponsors]: our-sponsors.md
|
|
||||||
[sponsoring page]: https://github.com/sponsors/squidfunk?metadata_origin=docs
|
|
||||||
|
|
||||||
## Private sponsors
|
|
||||||
|
|
||||||
For those preferring discretion, [setting your sponsorship to private] during
|
|
||||||
the sponsorship initiation process ensures your sponsorship remains unlisted,
|
|
||||||
keeping your affiliation with Material for MkDocs confidential.
|
|
||||||
|
|
||||||
This setting can be adjusted at any time through your GitHub account's
|
|
||||||
sponsorship settings.
|
|
||||||
|
|
||||||
For companies concerned about being visible as sponsors of any project due to
|
|
||||||
their privacy restrictions, creating a [bot account] on GitHub that is solely
|
|
||||||
used for sponsoring is advised. This account, set to sponsor privately, won't be
|
|
||||||
linked to any individual within your organization and provides an extra layer of anonymity.
|
|
||||||
|
|
||||||
[setting your sponsorship to private]: https://docs.github.com/en/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship#managing-the-privacy-setting-for-your-sponsorship
|
|
||||||
[bot account]: access-management.md/#bot-account
|
|
||||||
|
|
||||||
## Administrative requests
|
|
||||||
|
|
||||||
To focus on the development of our projects, we aim to reduce administrative
|
|
||||||
tasks as much as possible for our small team, utilizing GitHub Sponsors for
|
|
||||||
efficient sponsor management.
|
|
||||||
|
|
||||||
### Vendor agreements
|
|
||||||
|
|
||||||
Since GitHub Sponsors facilitates our sponsor transactions, they act as your
|
|
||||||
vendor. For vendor agreements or related queries, especially for organizations
|
|
||||||
with GitHub enterprise accounts, reaching out to [GitHub Support] is recommended.
|
|
||||||
|
|
||||||
[GitHub Support]: https://github.com/sponsors
|
|
||||||
|
|
||||||
### Non-disclosure agreements
|
|
||||||
|
|
||||||
Given our limited resources as a small team, we are unable to review and sign
|
|
||||||
NDAs. We advise those requiring such agreements to consult [our promise] for
|
|
||||||
reassurance. Additionally, please contact us if you have any questions at
|
|
||||||
sponsors@squidfunk.com
|
|
||||||
|
|
||||||
[our promise]: #our-promise
|
|
||||||
|
|
||||||
## Our promise
|
|
||||||
|
|
||||||
We recognize the importance of privacy for our organizational sponsors,
|
|
||||||
especially in the absence of formal agreements like [NDAs]. "Our Promise" is our
|
|
||||||
assurance of commitment to your confidentiality and discretion.
|
|
||||||
|
|
||||||
- __Confidential sponsorship:__ Your choice between public or private
|
|
||||||
sponsorship is respected to the fullest. For private sponsors, we guarantee your
|
|
||||||
relation with us remains confidential at all times, ensuring no public disclosure
|
|
||||||
of your sponsorship.
|
|
||||||
- __Logo usage and brand representation:__ Logo display and any form of public
|
|
||||||
acknowledgment are completely under your control and will only proceed with your
|
|
||||||
explicit consent. This ensures your brand is represented on your terms.
|
|
||||||
- __Marketing and communication:__ We commit not to use the details of your
|
|
||||||
sponsorship for marketing or promotional purposes without your approval.
|
|
||||||
Your sponsorship details are guarded with the highest level of confidentiality,
|
|
||||||
with no unauthorized use or disclosure.
|
|
||||||
|
|
||||||
[NDAs]: #non-disclosure-agreements
|
|
||||||
@@ -1,58 +0,0 @@
|
|||||||
# Runtime and cancellation
|
|
||||||
|
|
||||||
The sponsorship model for Material for MkDocs is facilitated through GitHub
|
|
||||||
Sponsors and, therefore, adheres to GitHub's policies. If you're curious about
|
|
||||||
the duration of your sponsorship and the cancellation process, you will find
|
|
||||||
everything you need to know below.
|
|
||||||
|
|
||||||
## Runtime
|
|
||||||
|
|
||||||
Sponsorships remain valid as long as monthly or yearly subscriptions are
|
|
||||||
active and only expire when you cancel the sponsorship or when your [payment
|
|
||||||
method expires].
|
|
||||||
|
|
||||||
[payment method expires]: #automatic-cancellation
|
|
||||||
|
|
||||||
## Cancellation process
|
|
||||||
|
|
||||||
Canceling your sponsorship initiates a cancellation request through GitHub,
|
|
||||||
which is scheduled to take effect at the end of your current billing cycle. This
|
|
||||||
means you'll retain access to Insiders until the cancellation officially becomes
|
|
||||||
effective.
|
|
||||||
|
|
||||||
All transactions are processed by GitHub and as we don't receive any information
|
|
||||||
regarding your payment, we can't provide details about when your cancellation
|
|
||||||
will be in place.
|
|
||||||
|
|
||||||
### How to cancel
|
|
||||||
|
|
||||||
To downgrade or cancel your sponsorship, please follow the [step-by-step guide
|
|
||||||
from GitHub]. If you have sponsored using an organizational account, ensure that
|
|
||||||
you cancel the sponsorship under that specific account, as the
|
|
||||||
[collaborator and sponsor accounts may differ].
|
|
||||||
|
|
||||||
[step-by-step guide from GitHub]: https://docs.github.com/en/billing/managing-billing-for-github-sponsors/downgrading-a-sponsorship#canceling-a-sponsorship
|
|
||||||
[collaborator and sponsor accounts may differ]: access-management.md/#collaborators
|
|
||||||
|
|
||||||
### Effects of cancellation
|
|
||||||
|
|
||||||
Upon the effective date of your cancellation, GitHub will automatically remove
|
|
||||||
you as a collaborator from the private Material for MkDocs Insiders repository.
|
|
||||||
You will no longer receive updates. However, you are welcome to continue using
|
|
||||||
the latest version available to you at the time of cancellation for as long as
|
|
||||||
you like.
|
|
||||||
|
|
||||||
!!! warning "GitHub deletes private forks"
|
|
||||||
|
|
||||||
Please note that once you lose your collaborator status, [GitHub will
|
|
||||||
automatically delete your private fork] of the Insiders repository, so you
|
|
||||||
may want to take steps to ensure that you have a local backup.
|
|
||||||
|
|
||||||
[GitHub will automatically delete your private fork]: 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
|
|
||||||
|
|
||||||
### Automatic cancellation
|
|
||||||
|
|
||||||
If your credit card expires, GitHub will automatically cancel your sponsorship
|
|
||||||
and remove you as a collaborator. Regularly checking your payment method is
|
|
||||||
recommended to avoid unintended cancellations. If it happens, you can
|
|
||||||
reinstate your sponsorship with a new credit card.
|
|
||||||
@@ -1,215 +0,0 @@
|
|||||||
# Sponsoring tiers
|
|
||||||
|
|
||||||
We offer a range of sponsoring tiers tailored to the diverse needs of our
|
|
||||||
community. Whether you're an individual user, or rooted in academia, or work in
|
|
||||||
an organization using our software commercially, there's a sponsoring tier
|
|
||||||
that suits your needs.
|
|
||||||
|
|
||||||
## Choosing a tier
|
|
||||||
|
|
||||||
Choosing the right sponsoring tier depends on your needs and how you intend to
|
|
||||||
use Material for MkDocs Insiders. Our tiers are categorized into [non-commercial]
|
|
||||||
and [commercial] use:
|
|
||||||
|
|
||||||
- __Non-commercial tiers__: Intended for individuals, Open Source projects,
|
|
||||||
and academic use
|
|
||||||
- __Commercial tiers__: Designed for organizations and enterprises of any size
|
|
||||||
|
|
||||||
Each [monthly sponsoring tier] offers a range of benefits tailored to your needs.
|
|
||||||
Benefits include access to our private Material for MkDocs Insiders repository,
|
|
||||||
priority handling of bug reports, and more, which vary by the number of
|
|
||||||
projects[^1] that you intend to build with it and collaborators required.
|
|
||||||
Remember, you can always [upgrade or downgrade] your
|
|
||||||
sponsorship level at any time.
|
|
||||||
|
|
||||||
[^1]:
|
|
||||||
A project is defined as a folder with a `mkdocs.yml` configuration file
|
|
||||||
that is built with Material for MkDocs Insiders. This is the only limitation
|
|
||||||
to follow – the number of documentation pages or the size of your project
|
|
||||||
is up to you.
|
|
||||||
|
|
||||||
[monthly sponsoring tier]: #monthly-sponsoring
|
|
||||||
[non-commercial]: #non-commercial-use
|
|
||||||
[commercial]: #commercial-use
|
|
||||||
[upgrade or downgrade]: #switching-tiers
|
|
||||||
|
|
||||||
## Monthly sponsoring
|
|
||||||
|
|
||||||
Monthly sponsoring tiers provide you with access to our private Material for
|
|
||||||
MkDocs Insiders repository. Your financial contribution supports the ongoing
|
|
||||||
development of both the Insiders and the community edition.
|
|
||||||
|
|
||||||
### Non-commercial use
|
|
||||||
|
|
||||||
Non-commercial use essentially means "personal use". This includes individuals
|
|
||||||
using the Insiders edition for personal or purely non-commercial Open Source
|
|
||||||
projects. We offer two different tiers for non-commercial use.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### The Individual
|
|
||||||
|
|
||||||
You love Material for MkDocs and use it for your Open Source project or personal
|
|
||||||
blog. You read about all the awesome features in Insiders, which are first
|
|
||||||
exclusively released to sponsors, and don't want to miss out.
|
|
||||||
|
|
||||||
__Rewards:__
|
|
||||||
|
|
||||||
- :material-door-open: Access to Insiders
|
|
||||||
- :material-charity: Non-commercial use for __1-2 projects__
|
|
||||||
|
|
||||||
_Not available anymore._
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### The Dedicated Individual
|
|
||||||
|
|
||||||
You use Material for MkDocs for several of your Open Source projects or personal
|
|
||||||
sites, and just love that you can build beautiful documentation without having
|
|
||||||
to worry about the constantly breaking JavaScript ecosystem – this is now
|
|
||||||
[@squidfunk's] job.
|
|
||||||
|
|
||||||
[@squidfunk's]: https://github.com/squidfunk
|
|
||||||
|
|
||||||
__Rewards:__
|
|
||||||
|
|
||||||
- :material-door-open: Access to Insiders
|
|
||||||
- :material-charity: Non-commercial use for __3+ projects__
|
|
||||||
|
|
||||||
_Not available anymore._
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Commercial use
|
|
||||||
|
|
||||||
Commercial use refers to any use of our 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.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### The Organization :star:
|
|
||||||
|
|
||||||
Your organization uses Material for MkDocs for its documentation or internal
|
|
||||||
knowledge base and wants to make sure that it is well-maintained and safe to use
|
|
||||||
for the years to come. You agree that $125 a month (less than 1 hour of a
|
|
||||||
skilled developer) is a clever investment into a solution, solving tons of
|
|
||||||
problems you don't want to fight yourself.
|
|
||||||
|
|
||||||
__Rewards:__
|
|
||||||
|
|
||||||
- :material-door-open: Access to Insiders
|
|
||||||
- :material-currency-usd: Commercial use for __1-9 projects__
|
|
||||||
- :material-run-fast: Your bug reports are __prioritized__
|
|
||||||
- :material-star: Backlink + placement of __small logo__
|
|
||||||
|
|
||||||
_Not available anymore._
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### The Global Organization :star::star:
|
|
||||||
|
|
||||||
Your organization runs many internal and public-facing sites that are built with
|
|
||||||
Material for MkDocs, helping you to share and manage knowledge efficiently.
|
|
||||||
You've evaluated several commercial alternatives which will cost you 3-4x more,
|
|
||||||
some of which with a smaller feature set. You agree that $250 a month (less than
|
|
||||||
2 hours of a skilled developer) is a very good deal for the value you're getting
|
|
||||||
out of it.
|
|
||||||
|
|
||||||
__Rewards:__
|
|
||||||
|
|
||||||
- :material-door-open: Access to Insiders
|
|
||||||
- :material-currency-usd: Commercial use for __10-49 projects__
|
|
||||||
- :material-run-fast: Your bug reports are __prioritized__
|
|
||||||
- :material-star: Backlink + placement of __logo__
|
|
||||||
|
|
||||||
_Not available anymore._
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### The Holistic Organization :star::star::star:
|
|
||||||
|
|
||||||
Your organization's day-to-day operations critically depend on Material for
|
|
||||||
MkDocs, and you need to make sure that bugs are fixed quickly to keep your
|
|
||||||
customers happy. You see your work as part of a larger ecosystem, realizing that
|
|
||||||
giving back is essential to keeping everything you fight for alive.
|
|
||||||
|
|
||||||
__Rewards:__
|
|
||||||
|
|
||||||
- :material-door-open: Access to Insiders
|
|
||||||
- :material-currency-usd: Commercial use for __50+ projects__
|
|
||||||
- :material-run-fast: Your bug reports are __prioritized__
|
|
||||||
- :material-star: Backlink + placement of __large logo__
|
|
||||||
- :material-face-agent: Private __email support__
|
|
||||||
|
|
||||||
_Not available anymore._
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## One-time sponsoring
|
|
||||||
|
|
||||||
For those who wish to contribute one-time without an ongoing subscription and
|
|
||||||
without receiving access to the exclusive Insiders features, we offer the
|
|
||||||
following one-time sponsoring tiers.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Just a Tip! :money_with_wings:
|
|
||||||
|
|
||||||
You asked a question or needed some help on a problem, and we've helped you
|
|
||||||
quickly. You want no perks, just good karma and a warm feeling of giving
|
|
||||||
something back.
|
|
||||||
|
|
||||||
_Not available anymore._
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### The Mentoring
|
|
||||||
|
|
||||||
A 1-hour video call with [@squidfunk], the creator and core maintainer of the
|
|
||||||
project. He is happy to share his experiences with you and help you with
|
|
||||||
anything related to his work.
|
|
||||||
|
|
||||||
__Popular topics are:__
|
|
||||||
|
|
||||||
- How to tailor Material for MkDocs to your needs
|
|
||||||
- How to start earning a living in Open Source
|
|
||||||
- How to make your Open Source project sustainable
|
|
||||||
|
|
||||||
[@squidfunk]: https://github.com/squidfunk
|
|
||||||
|
|
||||||
_Not available anymore._
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Custom amount
|
|
||||||
|
|
||||||
You're invited to contribute custom sponsorship amounts via GitHub Sponsors,
|
|
||||||
enabling you to support Material for MkDocs according to your preferences.
|
|
||||||
Please be aware that individuals need to pledge a minimum of $15 a month to
|
|
||||||
access Insiders, whereas organizations are encouraged to sponsor $125 a month or
|
|
||||||
more, based on their requirements.
|
|
||||||
|
|
||||||
Contributions exceeding these thresholds are highly appreciated. Please note
|
|
||||||
that one-time donations, regardless of their size, won't be granted access to
|
|
||||||
Insiders due to technical constraints.
|
|
||||||
|
|
||||||
## Switching tiers
|
|
||||||
|
|
||||||
You can easily switch between different sponsorship tiers — [upgrade] or
|
|
||||||
[downgrade] — at any time. Simply visit the @squidfunk's
|
|
||||||
[GitHub Sponsors profile] and adjust your sponsorship tier selection. Once
|
|
||||||
you've made the change, you'll immediately sponsor at the new tier.
|
|
||||||
|
|
||||||
If you exceed the number of projects within your current sponsorship limit, we
|
|
||||||
kindly request that you upgrade your sponsorship to a higher tier to retain
|
|
||||||
access to Material for MkDocs Insiders. The change takes effect immediately,
|
|
||||||
and the amount is prorated based on your [billing cycle].
|
|
||||||
|
|
||||||
[upgrade]: https://docs.github.com/en/billing/managing-billing-for-github-sponsors/upgrading-a-sponsorship
|
|
||||||
[downgrade]: https://docs.github.com/en/billing/managing-billing-for-github-sponsors/downgrading-a-sponsorship
|
|
||||||
[billing cycle]: https://docs.github.com/en/github/setting-up-and-managing-billing-and-payments-on-github/changing-the-duration-of-your-billing-cycle
|
|
||||||
[GitHub Sponsors profile]: https://github.com/sponsors/squidfunk
|
|
||||||
@@ -1,121 +0,0 @@
|
|||||||
# Why sponsor us
|
|
||||||
|
|
||||||
Material for MkDocs is an Open Source project that is developed and maintained
|
|
||||||
by a small team of individuals who want to devote as much time as possible to
|
|
||||||
make it better every day. We need to rely on the financial support of
|
|
||||||
[our awesome sponsors], who buy us the time to work on it.
|
|
||||||
|
|
||||||
[become a monthly sponsor]: sponsoring-tier.md
|
|
||||||
[our awesome sponsors]: our-sponsors.md
|
|
||||||
[squidfunk's sponsor profile]: https://github.com/sponsors/squidfunk/
|
|
||||||
|
|
||||||
## Who we are
|
|
||||||
|
|
||||||
While [the project was started] by @squidfunk as a personal side project, the
|
|
||||||
[Sponsorware] model that the project adopted in 2020 allowed him to build a
|
|
||||||
small team of amazing individuals around him, [who are now helping him] to
|
|
||||||
maintain the project, as well as the growing list of sponsors.
|
|
||||||
|
|
||||||
[the project was started]: #how-it-started
|
|
||||||
[sponsorware]: #sponsorware
|
|
||||||
[who are now helping him]: #where-we-are-today
|
|
||||||
|
|
||||||
### How it started
|
|
||||||
|
|
||||||
In 2015, albeit 10 years in the industry, @squidfunk was still quite new to
|
|
||||||
Open Source. Having just finished his latest Open Source project, he realized
|
|
||||||
that the project was too complex to be explained in a plain README on GitHub.
|
|
||||||
He needed a good documentation tool for this project.
|
|
||||||
|
|
||||||
After evaluating static site generators in general and Hugo, Sphinx and MkDocs
|
|
||||||
in particular, he quickly decided that MkDocs seemed a good choice, as it was
|
|
||||||
specifically aimed at technical project documentation and easy to use.
|
|
||||||
Unfortunately, all of the available themes looked dated, and since @squidfunk
|
|
||||||
is a very visual person, he just couldn't convince himself to call it a day.
|
|
||||||
|
|
||||||
He needed to build a theme.
|
|
||||||
|
|
||||||
Months later, in February 2016, [the first version] of Material for MkDocs was
|
|
||||||
released. Over the next years, @squidfunk being the sole maintainer, countless
|
|
||||||
feature requests were implemented and bugs were fixed, allowing the project to
|
|
||||||
gain popularity and reach almost 3,000 stars on GitHub by the end of 2019. It
|
|
||||||
is still his most popular project to date.
|
|
||||||
|
|
||||||
As the project grew, @squidfunk started to implement feature requests that made
|
|
||||||
sense from a general perspective, but not for his personal use. This was the
|
|
||||||
point where the project started to shift from a personal project to a
|
|
||||||
community-driven one, and began to feel like a secondary job. Having a primary
|
|
||||||
job, many maintainers burn out when their side projects become successful, which
|
|
||||||
is why @squidfunk decided to give the [Sponsorware] model a try and make
|
|
||||||
Material for MkDocs his primary job. This turned out to be an incredible success.
|
|
||||||
|
|
||||||
[the first version]: https://github.com/squidfunk/mkdocs-material/releases/tag/0.1.0
|
|
||||||
|
|
||||||
### Sponsorware
|
|
||||||
|
|
||||||
The Sponsorware model is simple – as a sponsor, you get early access to the
|
|
||||||
latest and greatest features of Material for MkDocs as part of [Insiders] before
|
|
||||||
everyone else gets to enjoy them, as you are the one making them possible with
|
|
||||||
your financial contributions.
|
|
||||||
|
|
||||||
Every new feature that lands in [Insiders] is linked to a funding goal with a
|
|
||||||
specific amount. Once this amount is reached, all of the features that are part
|
|
||||||
of this funding goal are merged into the community edition, making them
|
|
||||||
available to everyone. It is that simple.
|
|
||||||
|
|
||||||
This brand-new and still experimental approach not only helps keep the project
|
|
||||||
vibrant and cutting-edge but also ensures it can continue to meet and exceed
|
|
||||||
your expectations.
|
|
||||||
|
|
||||||
[Insiders]: index.md
|
|
||||||
|
|
||||||
### Where we are today
|
|
||||||
|
|
||||||
Fast forward to today, Material for MkDocs is a thriving community-supported
|
|
||||||
and well-funded project, with over 500 sponsors and a small but growing team,
|
|
||||||
used by international companies and organizations. The project has outgrown
|
|
||||||
its original purpose by far, as it has become so much more than just a theme –
|
|
||||||
a powerful documentation framework built on top of MkDocs.
|
|
||||||
|
|
||||||
Starting in 2020 with the advent of the [Sponsorware] model, the frequency of
|
|
||||||
releases has more than doubled, with a new release seeing the light of day on
|
|
||||||
average every 1-2 weeks. Moreover, our team responds to issues as fast as
|
|
||||||
possible, keeping the number of open issues low.
|
|
||||||
|
|
||||||
## Our pledge
|
|
||||||
|
|
||||||
We're working hard to make Material for MkDocs one of the best documentation
|
|
||||||
tools out there, ridiculously powerful, a pleasure to use and most importantly –
|
|
||||||
free and Open Source. It is the financial contributions of our awesome sponsors,
|
|
||||||
that allow us to do our best work.
|
|
||||||
|
|
||||||
It's a simple equation: as long as this project is funded, we can continue to
|
|
||||||
improve it, fix bugs, and add new features. We will continue to provide the
|
|
||||||
best possible support to our users and make sure that Material for MkDocs
|
|
||||||
remains a tool that you love to use.
|
|
||||||
|
|
||||||
If you sponsor us, your contribution helps us to pay for:
|
|
||||||
|
|
||||||
1. __Taxes__: Since we provide a service to our sponsors, we're of course
|
|
||||||
legally obligated and happy 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. We regard those projects and their maintainers as
|
|
||||||
essential for the persistence of Material for MkDocs.
|
|
||||||
|
|
||||||
3. __Team__: Our team is growing! With more funds available, we can pay more
|
|
||||||
individuals to help us make Material for MkDocs even better. Note that this
|
|
||||||
covers various aspects of the project, like the creation of new features,
|
|
||||||
bug resolution, support, and sponsor relations.
|
|
||||||
|
|
||||||
We are bootstrapped – no investors to please! If you decide to support us, you
|
|
||||||
help us stay independent and free from outside influence. This means we can
|
|
||||||
focus on building a solution that you love to use and keep ownership of your
|
|
||||||
documentation project without vendor lock-in.
|
|
||||||
|
|
||||||
[ Choose a sponsoring tier <span class="mdx-sponsorship-count" data-mdx-component="sponsorship-count"></span>][sponsoring-tiers]{ .md-button .md-button--primary .mdx-sponsorship-button }
|
|
||||||
|
|
||||||
[sponsoring-tiers]: sponsoring-tiers.md
|
|
||||||
@@ -1,67 +0,0 @@
|
|||||||
# Support
|
|
||||||
|
|
||||||
At the heart of Material for MkDocs is an open and supportive community dedicated
|
|
||||||
to freely sharing knowledge and insights. We strive to offer support to this
|
|
||||||
community, balancing our development efforts with the need to address community
|
|
||||||
questions effectively.
|
|
||||||
|
|
||||||
In order to streamline communication and direct you to the most appropriate
|
|
||||||
support channel, we've outlined our support structure below.
|
|
||||||
|
|
||||||
## Sponsoring support
|
|
||||||
|
|
||||||
If you have questions about Insiders or are considering becoming a sponsor,
|
|
||||||
@katharinalisalin is here to help. She handles all non-technical
|
|
||||||
sponsorship-related inquiries and is happy to provide the guidance you need.
|
|
||||||
Feel free to contact her at sponsors@squidfunk.com.
|
|
||||||
|
|
||||||
## Technical support
|
|
||||||
|
|
||||||
We are committed to providing technical support, ensuring all interactions
|
|
||||||
remain transparent and accessible. Our primary channels for technical inquiries,
|
|
||||||
therefore, are [our discussion board] and [our issue tracker] which are open to
|
|
||||||
the entire community.
|
|
||||||
|
|
||||||
[our discussion board]: #discussion-board
|
|
||||||
[our issue tracker]: #issue-tracker
|
|
||||||
|
|
||||||
|
|
||||||
### Discussion board
|
|
||||||
|
|
||||||
Our [discussion board] serves as the primary point of contact for technical
|
|
||||||
discussions, supported by both our community and our [Community Experts]. We
|
|
||||||
encourage searching the board for existing answers before posting new questions.
|
|
||||||
|
|
||||||
Direct support, particularly for core feature-related queries, is actively
|
|
||||||
provided here, whereas customization tips are often sourced from and shared by
|
|
||||||
our amazing community.
|
|
||||||
|
|
||||||
[Community Experts]: insiders/community-experts-program/index.md
|
|
||||||
[discussion board]: https://github.com/squidfunk/mkdocs-material/discussions
|
|
||||||
|
|
||||||
### Issue Tracker
|
|
||||||
|
|
||||||
For [reporting bugs] or submitting [change requests], our [issue tracker] offers
|
|
||||||
a transparent platform for community contributions. We encourage reporting bugs
|
|
||||||
found in the Insiders edition and in the community edition with the help of [our
|
|
||||||
contributing guides] through the public [issue tracker], mindful of not
|
|
||||||
disclosing the private Insiders' source code in line with our [fair use
|
|
||||||
policy].
|
|
||||||
|
|
||||||
This transparent approach ensures that solutions can benefit the entire
|
|
||||||
community and feature requests can get upvoted by the community which will
|
|
||||||
affect the speed of its development.
|
|
||||||
|
|
||||||
[reporting bugs]: contributing/reporting-a-bug.md
|
|
||||||
[change requests]: contributing/requesting-a-change.md
|
|
||||||
[our contributing guides]: ./contributing/index.md
|
|
||||||
[issue tracker]: https://github.com/squidfunk/mkdocs-material/issues
|
|
||||||
[public issue tracker]: https://github.com/squidfunk/mkdocs-material/issues
|
|
||||||
[fair use policy]: ./insiders/license.md/#fair-use-policy
|
|
||||||
|
|
||||||
### Prioritized support
|
|
||||||
|
|
||||||
Organizational sponsors at "The Organization" tier or higher are entitled to
|
|
||||||
prioritized bug support. While we cannot guarantee immediate resolution, as
|
|
||||||
some problems are harder to fix than others, it ensures that your issues are
|
|
||||||
addressed with urgency.
|
|
||||||
@@ -291,4 +291,4 @@ def _badge_for_experimental(page: Page, files: Files):
|
|||||||
href = _resolve_path("conventions.md#experimental", page, files)
|
href = _resolve_path("conventions.md#experimental", page, files)
|
||||||
return _badge(
|
return _badge(
|
||||||
icon = f"[:{icon}:]({href} 'Experimental')"
|
icon = f"[:{icon}:]({href} 'Experimental')"
|
||||||
)
|
)
|
||||||
|
|||||||
17
mkdocs.yml
17
mkdocs.yml
@@ -264,20 +264,7 @@ nav:
|
|||||||
- Tooltips: reference/tooltips.md
|
- Tooltips: reference/tooltips.md
|
||||||
- Insiders:
|
- Insiders:
|
||||||
- insiders/index.md
|
- insiders/index.md
|
||||||
- Why sponsor us: insiders/why-sponsor-us.md
|
- Getting started: insiders/getting-started.md
|
||||||
- What's in it for you: insiders/benefits.md
|
|
||||||
- Who is sponsoring: insiders/our-sponsors.md
|
|
||||||
- Sponsoring tiers: insiders/sponsoring-tiers.md
|
|
||||||
- How to sponsor: insiders/how-to-sponsor.md
|
|
||||||
- Additional information:
|
|
||||||
- Payment and billing: insiders/payment-and-billing.md
|
|
||||||
- Access management: insiders/access-management.md
|
|
||||||
- Runtime and cancellation: insiders/runtime-and-cancellation.md
|
|
||||||
- Privacy: insiders/privacy.md
|
|
||||||
- License: insiders/license.md
|
|
||||||
- Support: support.md
|
|
||||||
- Using Insiders:
|
|
||||||
- Getting started: insiders/getting-started.md
|
|
||||||
- Changelog:
|
- Changelog:
|
||||||
- insiders/changelog/index.md
|
- insiders/changelog/index.md
|
||||||
- How to upgrade: insiders/upgrade.md
|
- How to upgrade: insiders/upgrade.md
|
||||||
@@ -292,7 +279,5 @@ nav:
|
|||||||
- Asking a question: https://github.com/squidfunk/mkdocs-material/discussions
|
- Asking a question: https://github.com/squidfunk/mkdocs-material/discussions
|
||||||
- Guides:
|
- Guides:
|
||||||
- Creating a reproduction: guides/creating-a-reproduction.md
|
- Creating a reproduction: guides/creating-a-reproduction.md
|
||||||
- Community experts program:
|
|
||||||
- insiders/community-experts-program/index.md
|
|
||||||
- Blog:
|
- Blog:
|
||||||
- blog/index.md
|
- blog/index.md
|
||||||
|
|||||||
@@ -291,4 +291,4 @@ def _badge_for_experimental(page: Page, files: Files):
|
|||||||
href = _resolve_path("conventions.md#experimental", page, files)
|
href = _resolve_path("conventions.md#experimental", page, files)
|
||||||
return _badge(
|
return _badge(
|
||||||
icon = f"[:{icon}:]({href} 'Experimental')"
|
icon = f"[:{icon}:]({href} 'Experimental')"
|
||||||
)
|
)
|
||||||
|
|||||||
Reference in New Issue
Block a user