1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-12-24 21:35:00 +01:00
mkdocs-material/docs/insiders/index.md

596 lines
28 KiB
Markdown
Raw Normal View History

2020-07-22 16:05:38 +02:00
---
2021-03-21 17:14:32 +01:00
title: Insiders
2020-07-22 16:05:38 +02:00
---
2021-03-21 17:14:32 +01:00
# Insiders
2020-07-22 16:05:38 +02:00
2021-11-07 18:23:01 +01:00
Material for MkDocs follows the __sponsorware__ release strategy, which means
that new features are first exclusively released to sponsors as part of
[Insiders]. Read on to learn [what sponsorships achieve],
[how to become a sponsor] to get access to Insiders, and [what's in it for you]!
2020-12-21 17:38:58 +01:00
2022-10-02 17:50:19 +02:00
<!-- <figure class="mdx-video" markdown>
<div class="mdx-video__inner">
2022-02-27 18:19:04 +01:00
<iframe src="https://streamable.com/e/yslhdu" allowfullscreen></iframe>
2020-12-21 17:38:58 +01:00
</div>
2021-10-04 23:36:31 +02:00
<figcaption markdown>
2021-11-13 12:13:45 +01:00
This documentation is built with Insiders
2021-11-07 18:23:01 +01:00
[squidfunk.github.io/mkdocs-material][Material for MkDocs]
2020-12-21 17:38:58 +01:00
</figcaption>
2022-10-02 17:50:19 +02:00
</figure> -->
2020-12-21 17:38:58 +01:00
2021-11-07 18:23:01 +01:00
[Insiders]: #what-is-insiders
[what sponsorships achieve]: #what-sponsorships-achieve
[how to become a sponsor]: #how-to-become-a-sponsor
[what's in it for you]: #whats-in-it-for-me
2021-11-07 18:23:01 +01:00
[Material for MkDocs]: https://squidfunk.github.io/mkdocs-material/
2020-07-22 16:05:38 +02:00
2021-11-07 18:23:01 +01:00
## What is Insiders?
2020-07-22 17:56:47 +02:00
2021-11-07 18:23:01 +01:00
Material for MkDocs Insiders is a private fork of Material for MkDocs, hosted as
a private GitHub repository. Almost[^1] [all new features][what's in it for you]
2022-04-28 11:16:09 +02:00
are developed as part of this fork, which means that they are immediately
available to all eligible sponsors, as they are made collaborators of this
repository.
2021-02-04 21:14:38 +01:00
[^1]:
2021-11-07 18:23:01 +01:00
In general, every new feature is first exclusively released to sponsors, but
sometimes upstream dependencies like [Python Markdown Extensions] enhance
existing features that must be supported by Material for MkDocs.
Every feature is tied to a [funding goal] in monthly subscriptions. When a
funding goal is hit, the features that are tied to it are merged back into
Material for MkDocs and released for general availability, making them available
to all users. Bugfixes are always released in tandem.
2022-09-01 10:25:57 +02:00
Sponsorships start as low as [__$15 a month__][how to become a sponsor].[^2]
2021-11-07 18:23:01 +01:00
[^2]:
2022-09-01 10:25:57 +02:00
Note that $15 a month is the minimum amount to become eligible for
2021-11-07 18:23:01 +01:00
Insiders. While GitHub Sponsors also allows to sponsor lower amounts or
one-time amounts, those can't be granted access to Insiders due to
technical reasons.
[Python Markdown Extensions]: https://facelessuser.github.io/pymdown-extensions/
2021-11-07 18:28:38 +01:00
[funding goal]: #funding
2021-11-07 18:23:01 +01:00
## What sponsorships achieve
Sponsorships make this project sustainable, as they buy the maintainers of this
project time a very scarce resource which is spent on the development of new
features, bug fixing, stability improvement, issue triage and general support.
The biggest bottleneck in Open Source is time.[^3]
[^3]:
2021-11-07 18:59:18 +01:00
Making an Open Source project sustainable is exceptionally hard: maintainers
burn out, projects are abandoned. That's not great and very unpredictable.
The sponsorware model ensures that if you decide to use Material for MkDocs,
2021-02-04 21:14:38 +01:00
you can be sure that bugs are fixed quickly and new features are added
regularly.
2021-11-07 18:23:01 +01:00
If you're unsure if you should sponsor this project, check out the list of
[completed funding goals] to learn whether you're already using features that
were developed with the help of sponsorships. You're most likely using at least
a handful of them, [thanks to our awesome sponsors]!
2020-12-21 17:38:58 +01:00
2021-11-07 18:23:01 +01:00
[completed funding goals]: #goals-completed
[thanks to our awesome sponsors]: #how-to-become-a-sponsor
2020-07-22 17:56:47 +02:00
2022-12-18 11:05:09 +01:00
<figure style="min-width:15.6rem">
<blockquote class="twitter-tweet" data-conversation="none" data-dnt="true">
<a href="https://twitter.com/WillingCarol/status/1603416470616088576?ref_src=twsrc%5Etfw"></a>
</blockquote>
<script async src="https://platform.twitter.com/widgets.js"></script>
</figure>
## What's in it for me?
2022-07-06 09:00:38 +02:00
The moment you [become a sponsor][how to become a sponsor], you'll get __immediate
2024-02-24 06:46:13 +01:00
access to 26 additional features__ that you can __start using now__, and
2022-07-06 09:00:38 +02:00
which are currently exclusively available to sponsors:
<div class="mdx-columns" markdown>
2024-02-24 06:46:13 +01:00
- [x] [Blog plugin: pinned posts] :material-alert-decagram:{ .mdx-pulse title="Added on February 24, 2024" }
- [x] [Instant previews] :material-alert-decagram:{ .mdx-pulse title="Added on January 28, 2024" }
- [x] [Footnote tooltips] :material-alert-decagram:{ .mdx-pulse title="Added on January 24, 2024" }
- [x] [Tags plugin: advanced settings]
- [x] [Tags plugin: nested tags]
- [x] [Tags plugin: shadow tags]
- [x] [Stay on page when switching languages]
- [x] [Blog plugin: author profiles]
2023-12-23 21:32:20 +01:00
- [x] [Blog plugin: advanced settings]
2023-12-08 10:29:59 +01:00
- [x] [Projects plugin]
2023-11-26 15:46:58 +01:00
- [x] [Instant prefetching]
- [x] [Social plugin: custom layouts]
- [x] [Social plugin: background images]
2023-06-15 18:02:31 +02:00
- [x] [Code range selection]
2023-05-08 10:25:09 +02:00
- [x] [Code annotations: custom selectors]
- [x] [Privacy plugin: advanced settings]
2023-02-19 17:34:12 +01:00
- [x] [Optimize plugin]
- [x] [Navigation path] (Breadcrumbs)
2023-02-06 15:09:32 +01:00
- [x] [Typeset plugin]
2023-01-21 17:58:58 +01:00
- [x] [Privacy plugin: external links]
2023-01-14 20:29:27 +01:00
- [x] [Navigation subtitles]
2022-12-20 22:44:07 +01:00
- [x] [Tags plugin: allow list] + [custom sorting]
2022-10-18 09:32:22 +02:00
- [x] [Blog plugin: custom index pages]
2022-10-02 16:36:47 +02:00
- [x] [Blog plugin: related links]
- [x] [Meta plugin]
- [x] [Tags plugin: configurable listings]
2022-07-06 09:00:38 +02:00
</div>
New features are added every other week. Be sure to come back.
2020-12-21 17:38:58 +01:00
## How to become a sponsor
2021-11-07 18:23:01 +01:00
Thanks for your interest in sponsoring! In order to become an eligible sponsor
with your GitHub account, visit [squidfunk's sponsor profile], and complete
2022-09-01 10:25:57 +02:00
a sponsorship of __$15 a month or more__. You can use your individual or
2021-11-07 18:23:01 +01:00
organization GitHub account for sponsoring.
2020-12-21 17:38:58 +01:00
__Important__: If you're sponsoring @squidfunk through a GitHub organization,
please send a short email to sponsors@squidfunk.com with the name of your
2023-09-15 09:25:50 +02:00
organization and the GitHub account of the individual that should be added as a
2021-11-07 18:23:01 +01:00
collaborator.[^4]
2021-05-30 11:45:36 +02:00
2021-11-07 18:23:01 +01:00
You can cancel your sponsorship anytime.[^5]
2021-05-30 11:45:36 +02:00
2021-11-07 18:23:01 +01:00
[^4]:
2020-12-21 17:38:58 +01:00
It's currently not possible to grant access to each member of an
organization, as GitHub only allows for adding users. Thus, after
sponsoring, please send an email to sponsors@squidfunk.com, stating which
account should become a collaborator of the Insiders repository. We're
working on a solution which will make access to organizations much simpler.
To ensure that access is not tied to a particular individual GitHub account,
create a bot account (i.e. a GitHub account that is not tied to a specific
individual), and use this account for the sponsoring. After being added to
the list of collaborators, the bot account can create a private fork of the
private Insiders GitHub repository, and grant access to all members of the
organizations.
2021-11-07 18:23:01 +01:00
[^5]:
2020-12-22 11:38:28 +01:00
If you cancel your sponsorship, GitHub schedules a cancellation request
2021-05-30 11:45:36 +02:00
which will become effective at the end of the billing cycle. This means
that even though you cancel your sponsorship, you will keep your access to
Insiders as long as your cancellation isn't effective. All charges are
processed by GitHub through Stripe. As we don't receive any information
regarding your payment, and GitHub doesn't offer refunds, sponsorships are
non-refundable.
2020-12-21 17:38:58 +01:00
2021-11-07 18:23:01 +01:00
[:octicons-heart-fill-24:{ .mdx-heart } &nbsp; Join our <span class="mdx-sponsorship-count" data-mdx-component="sponsorship-count"></span> awesome sponsors][squidfunk's sponsor profile]{ .md-button .md-button--primary .mdx-sponsorship-button }
<hr />
2021-10-04 23:36:31 +02:00
<div class="mdx-premium" markdown>
2023-03-28 17:45:39 +02:00
**Silver sponsors**:
[![FastAPI]{ style="height: 120px" }](https://fastapi.tiangolo.com/){ target=_blank title="FastAPI" }
2023-11-09 16:56:54 +01:00
[![Trendpop]{ style="height: 120px" }](https://www.trendpop.com/){ target=_blank title="Trendpop" }
2024-02-20 02:03:31 +01:00
[![SailPoint]{ style="height: 120px" }](https://documentation.sailpoint.com/){ target=_blank title="SailPoint" }
2023-03-28 17:45:39 +02:00
**Bronze sponsors**:
[![Cirrus CI]](https://cirrus-ci.org/){ target=_blank title="Cirrus CI" }
2021-11-07 18:23:01 +01:00
[![Basler]](https://docs.baslerweb.com/){ target=_blank title="Basler" }
[![KX]](https://kx.com/){ target=_blank title="KX Systems" }
2021-11-10 08:43:38 +01:00
[![Prefect]](https://orion-docs.prefect.io/){ target=_blank title="Prefect" }
2022-02-10 21:12:05 +01:00
[![Zenoss]](https://zenoss.com/){ target=_blank title="Zenoss" }
[![Posit]](https://docs.posit.co){ target=_blank title="Posit" }
2022-04-13 09:42:16 +02:00
[![n8n]](https://n8n.io){ target=_blank title="n8n" }
2022-06-07 16:38:02 +02:00
[![Dogado]](https://www.dogado.de){ target=_blank title="Dogado" }
[![World Wide Technology]](https://wwt.com){ target=_blank title="World Wide Technology" }
2022-06-24 12:57:46 +02:00
[![Coda]](https://coda.io){ target=_blank title="Coda" }
2022-06-30 17:08:35 +02:00
[![Elastic]](https://elastic.co){ target=_blank title="Elastic" }
2022-07-13 09:51:50 +02:00
[![IP Fabric]](https://ipfabric.io/){ target=_blank title="IP Fabric" }
2022-07-14 11:42:36 +02:00
[![Apex.AI]](https://www.apex.ai/){ target=_blank title="Apex.AI" }
2022-08-26 08:34:55 +02:00
[![Jitterbit]](https://jitterbit.com/){ target=_blank title="Jitterbit" }
[![Sparkfun]](https://sparkfun.com/){ target=_blank title="Sparkfun Electronics" }
2022-09-25 10:18:29 +02:00
[![Eccenca]](https://eccenca.com/){ target=_blank title="Eccenca" }
2022-09-30 09:13:17 +02:00
[![Neptune]](https://neptune.ai/){ target=_blank title="Neptune" }
2022-12-31 13:12:45 +01:00
[![RackN]](https://rackn.com/){ target=_blank title="RackN" }
2023-02-03 13:51:44 +01:00
[![CivicActions]](https://civicactions.com/){ target=_blank title="CivicActions" }
2023-04-03 09:06:06 +02:00
[![bitcrowd]](https://bitcrowd.net/){ target=_blank title="bitcrowd" }
2023-04-17 11:25:41 +02:00
[![GetScreen.me]](https://getscreen.me/){ target=_blank title="GetScreen.me" }
[![BotCity]](https://botcity.dev/){ target=_blank title="BotCity" }
[![Springer Nature Technology]](https://www.springernature.com/gp){ target=_blank title="Springer Nature Technology" }
2023-06-13 10:19:14 +02:00
[![Kolena]](https://kolena.io/){ target=_blank title="Kolena" }
[![Evergiving]](https://www.evergiving.com/){ target=_blank title="Evergiving" }
2023-06-20 12:19:45 +02:00
[![Koor]](https://koor.tech/){ target=_blank title="Koor" }
2023-07-07 09:37:30 +02:00
[![Astral]](https://astral.sh/){ target=_blank title="Astral" }
2023-07-07 16:03:11 +02:00
[![Oikolab]](https://oikolab.com/){ target=_blank title="Oikolab" }
2023-08-26 09:58:03 +02:00
[![Bühler Group]](https://www.buhlergroup.com/){ target=_blank title="Bühler Group" }
2023-09-11 09:04:04 +02:00
[![Transformation Flow]](https://transformationflow.io/){ target=_blank title="Transformation Flow" }
2023-10-27 13:19:02 +02:00
[![3DR]](https://3dr.com/){ target=_blank title="3DR" }
2024-01-21 09:16:51 +01:00
[![Spotware]](https://spotware.com/){ target=_blank title="Spotware" }
2024-01-30 11:08:11 +01:00
[![Milford Assets]](https://milfordasset.com/){ target=_blank title="Milford Assets" }
2024-02-05 13:01:24 +01:00
[![Lechler]](https://www.lechler.com/){ target=_blank title="Lechler" }
2024-02-20 14:36:48 +01:00
[![Invers]](https://invers.com/){ target=_blank title="Invers" }
2024-02-27 05:35:04 +01:00
[![Maxar]](https://maxar.com/){ target=_blank title="Maxar" }
2024-03-06 07:22:40 +01:00
[![EquipmentShare]](https://www.equipmentshare.com/){ target=_blank title="EquipmentShare" }
2024-02-04 06:08:36 +01:00
</div>
2023-03-28 17:45:39 +02:00
[FastAPI]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-fastapi.png
2023-11-09 16:56:54 +01:00
[Trendpop]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-trendpop.png
2021-11-07 18:23:01 +01:00
[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
2021-11-10 08:43:38 +01:00
[Prefect]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-prefect.png
2022-02-10 21:12:05 +01:00
[Zenoss]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-zenoss.png
2023-03-17 15:42:04 +01:00
[Posit]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-posit.png
2022-04-13 09:42:16 +02:00
[n8n]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-n8n.png
2022-06-07 16:38:02 +02:00
[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
2022-06-24 12:57:46 +02:00
[Coda]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-coda.png
2022-06-30 17:08:35 +02:00
[Elastic]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-elastic.png
2022-07-13 09:51:50 +02:00
[IP Fabric]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-ip-fabric.png
2022-07-14 11:42:36 +02:00
[Apex.AI]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-apex-ai.png
2022-08-26 08:34:55 +02:00
[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
2022-09-25 10:18:29 +02:00
[Eccenca]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-eccenca.png
2022-09-30 09:13:17 +02:00
[Neptune]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-neptune-ai.png
2022-11-08 19:00:08 +01:00
[Cash App]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-cashapp.png
2022-12-31 13:12:45 +01:00
[RackN]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-rackn.png
2023-02-03 13:51:44 +01:00
[CivicActions]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-civic-actions.png
2023-04-03 09:06:06 +02:00
[bitcrowd]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-bitcrowd.png
2023-04-17 11:25:41 +02:00
[GetScreen.me]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-getscreenme.png
[BotCity]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-botcity.png
[Springer Nature Technology]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-sn-technology.png
2023-06-13 10:19:14 +02:00
[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
2023-06-20 12:19:45 +02:00
[Koor]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-koor.png
2023-07-07 09:37:30 +02:00
[Astral]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-astral.png
2023-07-07 16:03:11 +02:00
[Oikolab]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-oikolab.png
2023-08-26 09:58:03 +02:00
[Bühler Group]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-buhler.png
2023-09-11 09:04:04 +02:00
[Transformation Flow]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-transformationflow.png
2023-10-27 13:19:02 +02:00
[3DR]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-3dr.png
2024-01-21 09:16:51 +01:00
[Spotware]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-spotware.png
2024-01-30 11:08:11 +01:00
[Milford Assets]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-milford.png
2024-02-05 13:01:24 +01:00
[Lechler]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-lechler.png
2024-02-17 06:23:58 +01:00
[SailPoint]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-sailpoint.png
2024-02-20 14:36:48 +01:00
[Invers]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-invers.png
2024-02-27 05:35:04 +01:00
[Maxar]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-maxar.png
2024-03-06 07:22:40 +01:00
[EquipmentShare]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-equipmentshare.png
<hr />
<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>
2020-11-26 11:54:13 +01:00
</div>
2020-12-21 17:38:58 +01:00
2022-12-14 17:48:29 +01:00
[squidfunk's sponsor profile]: https://github.com/sponsors/squidfunk?metadata_origin=docs
2020-07-22 17:56:47 +02:00
## Funding <span class="mdx-sponsorship-total" data-mdx-component="sponsorship-total"></span>
2020-07-26 14:46:09 +02:00
2020-12-21 17:38:58 +01:00
### Goals
2020-07-26 14:46:09 +02:00
2021-11-07 18:23:01 +01:00
The following section lists all funding goals. Each goal contains a list of
features prefixed with a checkmark symbol, denoting whether a feature is
2023-09-15 09:25:50 +02:00
:octicons-check-circle-fill-24:{ style="color: #00e676" } already available or
2021-11-07 18:23:01 +01:00
:octicons-check-circle-fill-24:{ style="color: var(--md-default-fg-color--lightest)" } planned, but not yet implemented. When the funding goal is hit, the features
are released for general availability.
2022-06-04 13:29:47 +02:00
#### $ 16,000 Chipotle
- [x] [Meta plugin]
2022-09-12 10:47:38 +02:00
- [x] [Blog plugin: related links]
- [x] [Blog plugin: custom index pages]
- [x] [Tags plugin: configurable listings]
2023-02-19 17:34:12 +01:00
- [x] [Tags plugin: allow list] + [custom sorting]
2022-10-02 16:36:47 +02:00
- [x] [Navigation subtitles]
2022-06-04 13:29:47 +02:00
2023-09-15 09:25:50 +02:00
[Meta plugin]: ../plugins/meta.md
2022-09-11 19:25:40 +02:00
[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
2022-10-02 16:36:47 +02:00
[Navigation subtitles]: ../reference/index.md#setting-the-page-subtitle
2024-03-20 08:59:01 +01:00
#### $ 18,000 Lemon Drop
2022-10-02 16:36:47 +02:00
2023-01-21 17:58:58 +01:00
- [x] [Optimize plugin]
2023-01-14 20:29:27 +01:00
- [x] [Navigation path] (Breadcrumbs)
2023-11-26 15:46:58 +01:00
- [x] [Blog plugin: advanced settings]
- [x] [Blog plugin: author profiles]
2024-02-24 06:46:13 +01:00
- [x] [Blog plugin: pinned posts]
2024-03-20 08:59:01 +01:00
- [x] [Instant prefetching]
2022-10-02 16:36:47 +02:00
2023-09-15 09:25:50 +02:00
[Optimize plugin]: ../plugins/optimize.md
2023-01-14 20:29:27 +01:00
[Navigation path]: ../setup/setting-up-navigation.md#navigation-path
2023-11-26 15:46:58 +01:00
[Blog plugin: advanced settings]: ../setup/setting-up-a-blog.md#advanced-settings
2023-11-26 16:53:51 +01:00
[Blog plugin: author profiles]: ../setup/setting-up-a-blog.md#adding-author-profiles
2024-02-24 06:46:13 +01:00
[Blog plugin: pinned posts]: ../setup/setting-up-a-blog.md#pinning-a-post
2024-03-20 08:59:01 +01:00
[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
2024-01-24 09:45:24 +01:00
[Footnote tooltips]: ../reference/footnotes.md#footnote-tooltips
2024-03-20 08:59:01 +01:00
[Privacy plugin: external links]: ../plugins/privacy.md#external-links
[Privacy plugin: advanced settings]: ../setup/ensuring-data-privacy.md#advanced-settings
2022-02-20 19:49:23 +01:00
2024-03-20 08:59:01 +01:00
#### $ 22,000 Habanero Orange
2023-01-29 21:27:15 +01:00
2024-01-28 10:26:15 +01:00
- [x] [Instant previews]
2023-05-08 10:25:09 +02:00
- [x] [Social plugin: custom layouts]
- [x] [Social plugin: background images]
2023-02-19 17:34:12 +01:00
- [x] [Code range selection]
- [x] [Code annotations: custom selectors]
2023-12-08 10:29:59 +01:00
- [x] [Stay on page when switching languages]
2023-02-19 17:34:12 +01:00
2024-01-28 10:26:15 +01:00
[Instant previews]: ../setup/setting-up-navigation.md#instant-previews
2023-05-08 16:44:39 +02:00
[Social plugin: custom layouts]: ../setup/setting-up-social-cards.md#customization
[Social plugin: background images]: ../plugins/social.md#option.background_image
2023-02-19 17:34:12 +01:00
[Code range selection]: ../reference/code-blocks.md#code-selection-button
[Code annotations: custom selectors]: ../reference/code-blocks.md#custom-selectors
2023-12-08 10:29:59 +01:00
[Stay on page when switching languages]: ../setup/changing-the-language.md#stay-on-page
2024-03-20 08:59:01 +01:00
#### $ 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
2023-12-23 21:32:20 +01:00
[Tags plugin: advanced settings]: ../setup/setting-up-tags.md#advanced-settings
2023-01-29 21:27:15 +01:00
2024-01-24 09:45:24 +01:00
2020-12-21 17:38:58 +01:00
### Goals completed
2021-11-07 18:23:01 +01:00
This section lists all funding goals that were previously completed, which means
that those features were part of Insiders, but are now generally available and
can be used by all users.
2023-12-07 11:56:18 +01:00
#### $ 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
2023-07-06 17:38:39 +02:00
#### $ 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
2022-12-07 16:29:53 +01:00
#### $ 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
2022-09-13 13:27:13 +02:00
#### $ 8,000 Scotch Bonnet
- [x] [Social cards]
2023-02-19 17:34:12 +01:00
- [x] Code annotations: anchor links
2022-09-13 13:27:13 +02:00
- [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
2022-10-22 08:43:36 +02:00
[Tag icons]: ../setup/setting-up-tags.md#tag-icons-and-identifiers
2022-09-13 13:27:13 +02:00
[Table of contents anchor following]: ../setup/setting-up-navigation.md#anchor-following
2022-07-20 17:51:29 +02:00
#### $ 7,000 Royal Gold
- [x] [Cookie consent]
- [x] [Was this page helpful?]
- [x] [Dismissable announcement bar]
2022-09-11 19:25:40 +02:00
[Cookie consent]: ../setup/ensuring-data-privacy.md#cookie-consent
2022-07-20 17:51:29 +02:00
[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
2021-11-13 12:22:30 +01:00
#### $ 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
2021-09-23 09:23:42 +02:00
#### $ 3,000 Caribbean Red
2021-11-07 18:23:01 +01:00
- [x] [Sticky navigation tabs]
- [x] [Section index pages]
- [x] [Remove generator notice]
2021-09-23 09:23:42 +02:00
2021-11-07 18:23:01 +01:00
[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
2021-09-23 09:23:42 +02:00
2021-07-21 17:19:05 +02:00
#### $ 2,500 Biquinho Vermelho
2021-11-07 18:23:01 +01:00
- [x] [Search suggestions]
- [x] [Search highlighting]
- [x] [Search sharing]
2021-07-21 17:19:05 +02:00
2021-11-07 18:23:01 +01:00
[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
2021-07-21 17:19:05 +02:00
2021-03-29 18:59:53 +02:00
#### $ 2,000 Black Pearl
2020-12-21 17:38:58 +01:00
2021-03-29 18:59:53 +02:00
- [x] Latest release tag
2021-11-07 18:23:01 +01:00
- [x] [Color palette toggle]
- [x] [Back-to-top button]
2021-03-29 18:59:53 +02:00
2021-11-07 18:23:01 +01:00
[Color palette toggle]: ../setup/changing-the-colors.md#color-palette-toggle
[Back-to-top button]: ../setup/setting-up-navigation.md#back-to-top-button
2021-03-29 18:59:53 +02:00
#### $ 1,500 Bhut Jolokia
2021-11-07 18:23:01 +01:00
- [x] [Admonition inline blocks]
- [x] [Site language selection]
- [x] [Versioning]
2021-03-29 18:59:53 +02:00
2021-11-07 18:23:01 +01:00
[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
2020-07-22 17:56:47 +02:00
2020-12-21 17:38:58 +01:00
#### $ 1,000 Prairie Fire
2020-07-22 17:56:47 +02:00
2021-11-07 18:23:01 +01:00
- [x] [Navigation sections]
- [x] [Navigation expansion]
- [x] [Hiding the sidebars]
- [x] [Table of contents in navigation]
- [x] [Header hides on scroll]
2020-07-22 17:56:47 +02:00
2021-11-07 18:23:01 +01:00
[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
2020-07-22 18:30:00 +02:00
2021-03-29 18:59:53 +02:00
#### $ 500 Madame Jeanette
2021-02-22 23:42:26 +01:00
2021-03-29 18:59:53 +02:00
- [x] Improved search result grouping
- [x] Improved search result relevance and scoring
- [x] Missing query terms in search results
2021-02-22 23:42:26 +01:00
2020-09-03 23:18:02 +02:00
## Frequently asked questions
2020-07-22 18:30:00 +02:00
2020-09-03 23:18:02 +02:00
### Compatibility
2022-07-12 18:10:38 +02:00
_We're building an open source project and want to allow outside collaborators
to run and build our documentation locally without having access to Insiders.
Is this still possible?_
2020-09-03 23:18:02 +02:00
2021-11-07 18:23:01 +01:00
Yes. Insiders is compatible with Material for MkDocs. Almost all new features
2022-07-12 17:54:42 +02:00
and configuration options are either backward-compatible or implemented behind
2022-07-12 18:10:38 +02:00
feature flags. When working with outside collaborators, it should be rarely
necessary to change the general appearance of your site. Most Insiders features
enhance the overall experience, e.g. by adding icons to pages or providing a
feedback widget. While these features add value for the user of your site, they
2022-07-12 18:10:38 +02:00
shouldn't be necessary for previewing when making changes to content. Currently,
the only content-related features in Insiders that can't be properly previewed
by non-Insiders users are:
- [Annotations]
- [Card grids]
This means that outside collaborators are able to build the documentation
locally with Material for MkDocs and when they push their changes, your CI
pipeline will build it with Insiders. When using built-in plugins that are
exclusive to Insiders, it's recommended to split configuration into a base
`mkdocs.yml` and one with plugin overrides via [configuration inheritance].
2021-11-07 18:23:01 +01:00
See the [getting started guide] for more information.
2020-09-03 23:18:02 +02:00
2021-11-07 18:23:01 +01:00
[configuration inheritance]: https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance
2021-11-07 18:59:18 +01:00
[getting started guide]: getting-started.md#caveats
2020-10-11 12:20:36 +02:00
2021-05-30 11:45:36 +02:00
### Payment
_We don't want to pay for sponsorship every month. Are there any other options?_
Yes. You can sponsor on a yearly basis by [switching your GitHub account to a
2021-11-07 18:23:01 +01:00
yearly billing cycle][billing cycle]. If for some reason you cannot do that, you
could also create a dedicated GitHub account with a yearly billing cycle, which
you only use for sponsoring (some sponsors already do that).
2021-05-30 11:45:36 +02:00
2021-11-07 18:23:01 +01:00
If you have any problems or further questions, please reach out to
sponsors@squidfunk.com.
2021-05-30 11:45:36 +02:00
2021-11-07 18:23:01 +01:00
[billing cycle]: https://docs.github.com/en/github/setting-up-and-managing-billing-and-payments-on-github/changing-the-duration-of-your-billing-cycle
2021-05-30 11:45:36 +02:00
2020-09-03 23:18:02 +02:00
### Terms
2021-11-07 18:23:01 +01:00
_Are we allowed to use Insiders under the same terms and conditions as
Material for MkDocs?_
2020-09-03 23:18:02 +02:00
Yes. Whether you're an individual or a company, you may use _Material for MkDocs
Insiders_ precisely under the same terms as Material for MkDocs, which are given
2022-07-12 18:10:38 +02:00
by the [MIT license]. However, we kindly ask you to respect our
__fair use policy__:
2020-07-22 18:30:00 +02:00
2020-12-21 17:38:58 +01:00
- Please __don't distribute the source code__ of Insiders. You may freely use
2021-11-07 18:23:01 +01:00
it for public, private or commercial projects, privately fork or mirror it,
2023-09-15 09:25:50 +02:00
but please don't make the source code public, as it would counteract the
2021-11-07 18:23:01 +01:00
sponsorware strategy.
2020-07-22 18:30:00 +02:00
2021-11-07 18:23:01 +01:00
- If you cancel your subscription, you're automatically removed as a
collaborator and will miss out on all future updates of Insiders. However, you
may __use the latest version__ that's available to you __as long as you like__.
Just remember that [GitHub deletes private forks].
2020-07-22 18:30:00 +02:00
2021-11-07 18:23:01 +01:00
[MIT license]: ../license.md
[GitHub deletes private forks]: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository