mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-06-14 11:52:32 +03:00
Updated documentation
This commit is contained in:
squidfunk
parent
21744972ff
commit
5606b06153
BIN
.github/assets/sponsors/basler.png
vendored
BIN
.github/assets/sponsors/basler.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 16 KiB |
19
.github/assets/sponsors/cirrus-ci.svg
vendored
19
.github/assets/sponsors/cirrus-ci.svg
vendored
@ -1,19 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<svg version="1.1" viewBox="0 0 814 210" xmlns="http://www.w3.org/2000/svg">
|
||||
<style type="text/css">
|
||||
.st0{stroke:#212121;stroke-width:13.5;stroke-linecap:round;}
|
||||
.st1{fill:none;stroke:#212121;stroke-width:13.5;stroke-linecap:round;}
|
||||
.st2{fill:#212121;}
|
||||
.st3{font-family:Helvetica,sans-serif;}
|
||||
.st4{font-size:126.7641px;}
|
||||
</style>
|
||||
<g transform="translate(7 7)">
|
||||
<path class="st0" d="m61 156.5h111"/>
|
||||
<path class="st1" d="m172 156.5c11.6 0 21-9.4 21-21.1s-9.4-21.1-21-21.1"/>
|
||||
<path class="st0" d="m61 114.3h111"/>
|
||||
<path class="st1" d="m172 114.3c11.6 0 21-9.4 21-21.1s-9.4-21.1-21-21.1"/>
|
||||
<path class="st0" d="m61 72.2h111"/>
|
||||
<path class="st1" d="M172,72.2c11.6,0,21-9.4,21-21.1S183.6,30,172,30"/>
|
||||
</g>
|
||||
<text class="st2 st3 st4" transform="translate(260 163.49)">Cirrus CI</text>
|
||||
</svg>
|
||||
|
Before Width: | Height: | Size: 878 B |
BIN
.github/assets/sponsors/hummingbot.png
vendored
BIN
.github/assets/sponsors/hummingbot.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 22 KiB |
8
.github/assets/sponsors/kx.svg
vendored
8
.github/assets/sponsors/kx.svg
vendored
@ -1,8 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<svg width="100%" height="100%" viewBox="0 0 67 34" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;">
|
||||
<g transform="matrix(0.875037,0,0,0.875037,4.13627,2.11187)">
|
||||
<rect id="Rectangle_121" x="0" y="0" width="9.9" height="33.8"/>
|
||||
<path id="Path_514" d="M21.1,0L9.9,16.9L21.1,33.8L32.4,33.8L21.1,16.9L32.4,0L21.1,0Z" style="fill-rule:nonzero;"/>
|
||||
<path id="Path_515" d="M54.9,0L49.3,8.5L43.7,0L32.4,0L43.7,16.9L32.4,33.8L43.7,33.8L49.3,25.4L54.9,33.8L66.2,33.8L54.9,16.9L66.2,0L54.9,0Z" style="fill-rule:nonzero;"/>
|
||||
</g>
|
||||
</svg>
|
||||
|
Before Width: | Height: | Size: 793 B |
BIN
.github/assets/sponsors/manticoregames.png
vendored
BIN
.github/assets/sponsors/manticoregames.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 47 KiB |
@ -8,19 +8,19 @@ Have a question? Before you do, please read the following guidelines.
|
||||
### Got a question or problem?
|
||||
|
||||
For quick questions there's no need to open an issue as you can reach us on
|
||||
[gitter.im][1].
|
||||
[gitter.im].
|
||||
|
||||
[1]: https://gitter.im/squidfunk/mkdocs-material
|
||||
[gitter.im]: https://gitter.im/squidfunk/mkdocs-material
|
||||
|
||||
### Found a bug?
|
||||
|
||||
If you found a bug in the source code, you can help us by submitting an issue
|
||||
to the [issue tracker][2] in our GitHub repository. Even better, you can submit
|
||||
to the [issue tracker] in our GitHub repository. Even better, you can submit
|
||||
a Pull Request with a fix. However, before doing so, please read the
|
||||
[submission guidelines][3].
|
||||
[submission guidelines].
|
||||
|
||||
[2]: https://github.com/squidfunk/mkdocs-material/issues
|
||||
[3]: #submission-guidelines
|
||||
[issue tracker]: https://github.com/squidfunk/mkdocs-material/issues
|
||||
[submission guidelines]: #submission-guidelines
|
||||
|
||||
### Missing a feature?
|
||||
|
||||
@ -62,21 +62,21 @@ Search GitHub for an open or closed PR that relates to your submission. You
|
||||
don't want to duplicate effort. If you do not find a related issue or PR,
|
||||
go ahead.
|
||||
|
||||
1. **Development**: Fork the project, set up the [development environment][4],
|
||||
make your changes in a separate git branch and add descriptive messages to
|
||||
your commits.
|
||||
1. **Development**: Fork the project, set up the [development environment],
|
||||
make your changes in a separate git branch and add descriptive messages to
|
||||
your commits.
|
||||
|
||||
2. **Build**: Before submitting a pull requests, [build the theme][5]. This is
|
||||
a mandatory requirement for your PR to get accepted, as the theme should at
|
||||
all times be installable through GitHub.
|
||||
2. **Build**: Before submitting a pull requests, [build the theme]. This is
|
||||
a mandatory requirement for your PR to get accepted, as the theme should at
|
||||
all times be installable through GitHub.
|
||||
|
||||
3. **Pull Request**: After building the theme, commit the compiled output, push
|
||||
your branch to GitHub and send a PR to `mkdocs-material:master`. If we
|
||||
suggest changes, make the required updates, rebase your branch and push the
|
||||
changes to your GitHub repository, which will automatically update your PR.
|
||||
3. **Pull Request**: After building the theme, commit the compiled output,
|
||||
push your branch to GitHub and send a PR to `mkdocs-material:master`. If we
|
||||
suggest changes, make the required updates, rebase your branch and push the
|
||||
changes to your GitHub repository, which will automatically update your PR.
|
||||
|
||||
After your PR is merged, you can safely delete your branch and pull the changes
|
||||
from the main (upstream) repository.
|
||||
|
||||
[4]: https://squidfunk.github.io/mkdocs-material/customization/#environment-setup
|
||||
[5]: https://squidfunk.github.io/mkdocs-material/customization/#build-process
|
||||
[development environment]: https://squidfunk.github.io/mkdocs-material/customization/#environment-setup
|
||||
[build the theme]: https://squidfunk.github.io/mkdocs-material/customization/#build-process
|
||||
|
||||
53
README.md
53
README.md
@ -62,20 +62,23 @@
|
||||
<p id="premium-sponsors" align="center"><strong>Special thanks</strong> to our <strong>premium sponsors</strong>:</p>
|
||||
<p> </p>
|
||||
<p align="center">
|
||||
<a href="https://www.manticoregames.com/" target=_blank><img
|
||||
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/manticoregames.png" height="40"
|
||||
/></a>
|
||||
<a href="https://kx.com/" target=_blank><img
|
||||
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/kx.svg" height="40"
|
||||
/></a>
|
||||
<a href="https://hummingbot.io/" target=_blank><img
|
||||
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/hummingbot.png" height="40"
|
||||
/></a>
|
||||
<a href="https://docs.baslerweb.com/" target=_blank><img
|
||||
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/basler.png" height="40"
|
||||
/></a>
|
||||
<a href="https://cirrus-ci.org/" target=_blank><img
|
||||
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/cirrus-ci.svg" height="40"
|
||||
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-cirrus-ci.png" height="65"
|
||||
/></a>
|
||||
<a href="https://docs.baslerweb.com/" target=_blank><img
|
||||
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-basler.png" height="65"
|
||||
/></a>
|
||||
<a href="https://hummingbot.io/" target=_blank><img
|
||||
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-hummingbot.png" height="65"
|
||||
/></a><br />
|
||||
<a href="https://kx.com/" target=_blank><img
|
||||
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-kx.png" height="65"
|
||||
/></a>
|
||||
<a href="https://www.manticoregames.com/" target=_blank><img
|
||||
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-manticore-games.png" height="65"
|
||||
/></a>
|
||||
<a href="https://www.accounttechnologies.com/" target=_blank><img
|
||||
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-account-technologies.png" height="65"
|
||||
/></a>
|
||||
</p>
|
||||
<p> </p>
|
||||
@ -88,7 +91,7 @@
|
||||
|
||||
* **... but there's more** — integrates natively with Python Markdown
|
||||
Extensions, adding callouts, tabbed content containers, mathematical formulas,
|
||||
critic markup, task lists, and [more than 10k icons and emojis][2].
|
||||
critic markup, task lists, and [more than 10k icons and emojis][icons-emojis].
|
||||
|
||||
* **Responsive by design** — built from the ground up to work on all kinds of
|
||||
devices – from mobile phones to widescreens. The underlying fluid layout will
|
||||
@ -114,15 +117,17 @@
|
||||
on top of TypeScript, RxJS, and SCSS, bringing excellent possibilities for
|
||||
theme extension and customization.
|
||||
|
||||
_Material for MkDocs uses the [sponsorware][3] release strategy, which means
|
||||
that new features are first exclusively released to sponsors as part of Material
|
||||
for MkDocs Insiders. Read on to learn [how sponsorship works][4], and how you
|
||||
can [become a sponsor][5]._
|
||||
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 for you][available features]!
|
||||
|
||||
[2]: https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/#search
|
||||
[3]: https://github.com/sponsorware/docs
|
||||
[4]: https://squidfunk.github.io/mkdocs-material/insiders/#how-sponsorship-works
|
||||
[5]: https://squidfunk.github.io/mkdocs-material/insiders/#how-to-become-a-sponsor
|
||||
[icons-emojis]: https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/
|
||||
[Insiders]: https://squidfunk.github.io/mkdocs-material/insiders/#what-is-insiders
|
||||
[what sponsorships achieve]: https://squidfunk.github.io/mkdocs-material/insiders/#what-sponsorships-achieve
|
||||
[how to become a sponsor]: https://squidfunk.github.io/mkdocs-material/insiders/#how-to-become-a-sponsor
|
||||
[available features]: https://squidfunk.github.io/mkdocs-material/insiders/#available-features
|
||||
|
||||
## Quick start
|
||||
|
||||
@ -140,9 +145,9 @@ theme:
|
||||
```
|
||||
|
||||
For other installation methods, configuration options, and a demo, visit
|
||||
[squidfunk.github.io/mkdocs-material][1]
|
||||
[squidfunk.github.io/mkdocs-material][Material for MkDocs]
|
||||
|
||||
[1]: https://squidfunk.github.io/mkdocs-material/
|
||||
[Material for MkDocs]: https://squidfunk.github.io/mkdocs-material/
|
||||
|
||||
## Trusted by ...
|
||||
|
||||
|
||||
@ -117,6 +117,10 @@ and much more:
|
||||
|
||||
</div>
|
||||
|
||||
Furthermore, see the list of supported [Markdown extensions] that are natively
|
||||
integrated with Material for MkDocs, delivering a low-effort and unprecedented
|
||||
technical writing experience.
|
||||
|
||||
[Changing the colors]: setup/changing-the-colors.md
|
||||
[Changing the fonts]: setup/changing-the-fonts.md
|
||||
[Changing the language]: setup/changing-the-language.md
|
||||
@ -131,6 +135,7 @@ and much more:
|
||||
[Setting up the footer]: setup/setting-up-the-footer.md
|
||||
[Adding a git repository]: setup/adding-a-git-repository.md
|
||||
[Adding a comment system]: setup/adding-a-comment-system.md
|
||||
[Markdown extensions]: setup/extensions/index.md
|
||||
|
||||
## Previewing as you write
|
||||
|
||||
|
||||
@ -58,10 +58,9 @@ The following plugins are bundled with the Docker image:
|
||||
|
||||
??? question "How to add plugins to the Docker image?"
|
||||
|
||||
Material for MkDocs bundles useful and common plugins while trying not to
|
||||
blow up the size of the official image. If the plugin you want to use is
|
||||
not included, create a new `Dockerfile` and extend the official Docker image
|
||||
with your custom installation routine:
|
||||
Material for MkDocs only bundles selected plugins in order to keep the size
|
||||
of the official image small. If the plugin you want to use is not included,
|
||||
create a new `Dockerfile` and extend the official Docker image:
|
||||
|
||||
``` Dockerfile
|
||||
FROM squidfunk/mkdocs-material
|
||||
|
||||
@ -5,30 +5,40 @@ title: Switching to Insiders
|
||||
|
||||
# Switching to Insiders
|
||||
|
||||
Material for MkDocs Insiders is a fully compatible drop-in replacement for
|
||||
Material for MkDocs, and can be installed similar to the public version using
|
||||
[`pip`][pip], [`docker`][docker] or [`git`][git]. When you sponsor @squidfunk,
|
||||
your account is added to the list of collaborators of the private Insiders
|
||||
repository.
|
||||
Material for MkDocs Insiders is a fully compatible drop-in replacement[^1] for
|
||||
Material for MkDocs, and can be installed similarily using [`pip`][pip],
|
||||
[`docker`][docker] or [`git`][git]. Note that in order to get access to the
|
||||
Insiders repository, you need to [become an eligible sponsor] of @squidfunk.
|
||||
|
||||
[^1]:
|
||||
While Insiders always strives for full downward compatibility with Material
|
||||
for MkDocs, there are some cases which slightly deviate from the non-Insiders,
|
||||
|
||||
because
|
||||
configuration can't be shared due to limitations of MkDocs. This is
|
||||
particularly true for the `plugins` configuration, as Insiders provides
|
||||
several built-in plugins.
|
||||
|
||||
[pip]: #with-pip
|
||||
[docker]: #with-docker
|
||||
[git]: #with-git
|
||||
[become an eligible sponsor]: index.md#how-to-become-a-sponsor
|
||||
|
||||
## Requirements
|
||||
|
||||
In order to access the Insiders repository programmatically (from the command
|
||||
After you've been added to the list of collaborators and accepted the
|
||||
invitation, the Insiders repository programmatically (from the command
|
||||
line or GitHub Actions workflows), you need to create a [personal access
|
||||
token][4]:
|
||||
token]:
|
||||
|
||||
1. Go to https://github.com/settings/tokens
|
||||
2. Click on [Generate a new token][5]
|
||||
3. Enter a name and select the [`repo`][6] scope
|
||||
2. Click on [Generate a new token]
|
||||
3. Enter a name and select the [`repo`][scopes] scope
|
||||
4. Generate the token and store it in a safe place
|
||||
|
||||
[4]: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token
|
||||
[5]: https://github.com/settings/tokens/new
|
||||
[6]: https://docs.github.com/en/developers/apps/scopes-for-oauth-apps#available-scopes
|
||||
[personal access token]: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token
|
||||
[Generate a new token]: https://github.com/settings/tokens/new
|
||||
[scopes]: https://docs.github.com/en/developers/apps/scopes-for-oauth-apps#available-scopes
|
||||
|
||||
## Installation
|
||||
|
||||
@ -49,27 +59,28 @@ private repositories.
|
||||
|
||||
In case you want to use Material for MkDocs Insiders from within Docker, some
|
||||
additional steps are necessary. While we cannot provide a hosted Docker image
|
||||
for Insiders[^1], [GitHub Container Registry][7] allows for simple and
|
||||
for Insiders[^2], [GitHub Container Registry] allows for simple and
|
||||
comfortable self-hosting:
|
||||
|
||||
1. [Fork the Insiders repository][8]
|
||||
2. Enable [GitHub Actions][9] on your fork[^2]
|
||||
3. Create a new personal access token[^3]
|
||||
1. [Fork the Insiders repository]
|
||||
2. Enable [GitHub Actions] on your fork[^3]
|
||||
3. Create a new personal access token[^4]
|
||||
1. Go to https://github.com/settings/tokens
|
||||
2. Click on [Generate a new token][5]
|
||||
3. Enter a name and select the [`write:packages`][10] scope
|
||||
2. Click on [Generate a new token]
|
||||
3. Enter a name and select the [`write:packages`][scopes] scope
|
||||
4. Generate the token and store it in a safe place
|
||||
4. Add a [GitHub Actions secret][11] on your fork
|
||||
4. Add a [GitHub Actions secret] on your fork
|
||||
1. Set the name to `GHCR_TOKEN`
|
||||
2. Set the value to the personal access token created in the previous step
|
||||
5. [Create a new release][12] to build and publish the Docker image
|
||||
6. Install [Pull App][13] on your fork to stay in-sync with upstream
|
||||
5. [Create a new release] to build and publish the Docker image
|
||||
6. Install [Pull App] on your fork to stay in-sync with upstream
|
||||
|
||||
The [`publish`][14] workflow[^4] is automatically run when a new tag (release)
|
||||
is created. When a new Insiders version is released on the upstream repository,
|
||||
the [Pull App][13] will create a pull request with the changes and pull in the
|
||||
new tag, which is picked up by the [`publish`][14] workflow that builds and
|
||||
publishes the Docker image automatically to your private registry.
|
||||
The [`publish`][publish] workflow[^5] is automatically run when a new tag
|
||||
(release) is created. When a new Insiders version is released on the upstream
|
||||
repository, the [Pull App] will create a pull request with the changes and
|
||||
pull in the new tag, which is picked up by the [`publish`][publish] workflow
|
||||
that builds and publishes the Docker image automatically to your private
|
||||
registry.
|
||||
|
||||
Now, you should be able to pull the Docker image from your private registry:
|
||||
|
||||
@ -78,23 +89,23 @@ docker login -u ${GH_USERNAME} -p ${GHCR_TOKEN} ghcr.io
|
||||
docker pull ghcr.io/${GH_USERNAME}/mkdocs-material-insiders
|
||||
```
|
||||
|
||||
[^1]:
|
||||
[^2]:
|
||||
Earlier, Insiders provided a dedicated Docker image which was available to
|
||||
all sponsors. On March 21, 2021, the image was deprecated for the reasons
|
||||
outlined and discussed in #2442. It was removed on June 1, 2021.
|
||||
|
||||
[^2]:
|
||||
[^3]:
|
||||
When forking a repository, GitHub will disables all workflows. While this
|
||||
is a reasonable default setting, you need to enable GitHub Actions to be
|
||||
able to automatically build and publish a Docker image on
|
||||
[GitHub Container Registry][7].
|
||||
[GitHub Container Registry].
|
||||
|
||||
[^3]:
|
||||
[^4]:
|
||||
While you could just add the `write:packages` scope to the personal access
|
||||
token created to access the Insiders repository, it's safer to create a
|
||||
dedicated token which you'll only use for publishing the Docker image.
|
||||
|
||||
[^4]:
|
||||
[^5]:
|
||||
The Insiders repository contains three GitHub Actions workflows:
|
||||
|
||||
- `build.yml` – Build and lint the project (disabled on forks)
|
||||
@ -117,11 +128,13 @@ plugins:
|
||||
pip install -e mkdocs-material
|
||||
```
|
||||
|
||||
[7]: https://docs.github.com/en/packages/guides/about-github-container-registry
|
||||
[8]: https://github.com/squidfunk/mkdocs-material-insiders/fork
|
||||
[9]: https://docs.github.com/en/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository
|
||||
[10]: https://docs.github.com/en/developers/apps/scopes-for-oauth-apps#available-scopes
|
||||
[11]: https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository
|
||||
[12]: https://docs.github.com/en/github/administering-a-repository/managing-releases-in-a-repository#creating-a-release
|
||||
[13]: https://github.com/apps/pull
|
||||
[14]: https://github.com/squidfunk/mkdocs-material-insiders/blob/master/.github/workflows/publish.yml
|
||||
[GitHub Container Registry]: https://docs.github.com/en/packages/guides/about-github-container-registry
|
||||
[Fork the Insiders repository]: https://github.com/squidfunk/mkdocs-material-insiders/fork
|
||||
[GitHub Actions]: https://docs.github.com/en/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository
|
||||
[packages scope]: https://docs.github.com/en/developers/apps/scopes-for-oauth-apps#available-scopes
|
||||
[GitHub Actions secret]: https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository
|
||||
[Create a new release]: https://docs.github.com/en/github/administering-a-repository/managing-releases-in-a-repository#creating-a-release
|
||||
[Pull App]: https://github.com/apps/pull
|
||||
[publish]: https://github.com/squidfunk/mkdocs-material-insiders/blob/master/.github/workflows/publish.yml
|
||||
|
||||
## Caveats
|
||||
|
||||
@ -5,10 +5,11 @@ title: Insiders
|
||||
|
||||
# Insiders
|
||||
|
||||
Material for MkDocs follows the _sponsorware_ release strategy, which means
|
||||
that _new features are first exclusively released to sponsors_ as part of
|
||||
__Insiders__. Read on to learn [how sponsorship works][1], and how easy it is
|
||||
to [get access to Insiders][2].
|
||||
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 for you][available features]!
|
||||
|
||||
<figure class="mdx-video" markdown>
|
||||
<div class="mdx-video__inner">
|
||||
@ -17,64 +18,83 @@ to [get access to Insiders][2].
|
||||
<figcaption markdown>
|
||||
|
||||
The official documentation is built with Insiders
|
||||
[squidfunk.github.io/mkdocs-material][3]
|
||||
[squidfunk.github.io/mkdocs-material][Material for MkDocs]
|
||||
|
||||
</figcaption>
|
||||
</figure>
|
||||
|
||||
[1]: #how-sponsorship-works
|
||||
[2]: #how-to-become-a-sponsor
|
||||
[3]: https://squidfunk.github.io/mkdocs-material/
|
||||
[Insiders]: #what-is-insiders
|
||||
[what sponsorships achieve]: #what-sponsorships-achieve
|
||||
[how to become a sponsor]: #how-to-become-a-sponsor
|
||||
[available features]: #available-features
|
||||
[Material for MkDocs]: https://squidfunk.github.io/mkdocs-material/
|
||||
|
||||
## How sponsorship works
|
||||
## What is Insiders?
|
||||
|
||||
New features first land in Insiders, so _eligible sponsors have immediate
|
||||
access_. 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. Bugfixes are
|
||||
always released simultaneously in both editions.[^1]
|
||||
Material for MkDocs Insiders is a private fork of Material for MkDocs, hosted as
|
||||
a private GitHub repository. Almost[^1] all new features are developed as part of
|
||||
this fork, which means that they are immediately available to all eligible
|
||||
sponsors, as they are made collaborators of this repository.
|
||||
|
||||
[^1]:
|
||||
You may ask yourself why you should pay for something that is Open Source.
|
||||
Doesn't that contradict the ethos of Open Source software? Yes and no. Yes,
|
||||
some features are locked behind a monthly subscription, which means they are
|
||||
only accessible when paying a small amount of money. No, the features are
|
||||
only exclusive for a short time until specific funding goals are hit. Making
|
||||
In general, every new feature is first exclusively released to sponsors, but
|
||||
sometimes upstream dependencies like [Python Markdown Extensions] enhance
|
||||
existing features that must be supported by Material for MkDocs.
|
||||
|
||||
Every feature is tied to a [funding goal] in monthly subscriptions. When a
|
||||
funding goal is hit, the features that are tied to it are merged back into
|
||||
Material for MkDocs and released for general availability, making them available
|
||||
to all users. Bugfixes are always released in tandem.
|
||||
|
||||
Sponsorships start as low as [__$10 a month__][how to become a sponsor].[^2]
|
||||
|
||||
[^2]:
|
||||
Note that $10 a month is the minimum amount to become eligible for
|
||||
Insiders. While GitHub Sponsors also allows to sponsor lower amounts or
|
||||
one-time amounts, those can't be granted access to Insiders due to
|
||||
technical reasons.
|
||||
|
||||
[Python Markdown Extensions]: https://facelessuser.github.io/pymdown-extensions/
|
||||
[funding goal]: #goals
|
||||
|
||||
## What sponsorships achieve
|
||||
|
||||
Sponsorships make this project sustainable, as they buy the maintainers of this
|
||||
project time – a very scarce resource – which is spent on the development of new
|
||||
features, bug fixing, stability improvement, issue triage and general support.
|
||||
The biggest bottleneck in Open Source is time.[^3]
|
||||
|
||||
[^3]:
|
||||
Making
|
||||
an Open Source project sustainable is exceptionally hard: maintainers burn
|
||||
out, projects are abandoned. That's not great and very unpredictable. The
|
||||
sponsorware model ensures that if you decide to use Material for MkDocs,
|
||||
you can be sure that bugs are fixed quickly and new features are added
|
||||
regularly.
|
||||
|
||||
_Don't want to sponsor? No problem, Material for MkDocs already has tons of
|
||||
features available, so chances are that most of your requirements are already
|
||||
satisfied. See the [list of exclusive features][4] to learn which features are
|
||||
currently only available to sponsors._
|
||||
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]!
|
||||
|
||||
[4]: #exclusive-features
|
||||
[completed funding goals]: #goals-completed
|
||||
[thanks to our awesome sponsors]: #how-to-become-a-sponsor
|
||||
|
||||
## How to become a sponsor
|
||||
|
||||
You can become an eligible sponsor with your individual or organization's GitHub
|
||||
account. Visit __[squidfunk's sponsor profile][5]__, pick any tier __from
|
||||
$10/month__[^2], and complete the checkout. Then, after a few hours, @squidfunk
|
||||
will add you as a collaborator to the super-secret private GitHub repositority
|
||||
containing the Insiders edition, which contains all [brand new and exclusive
|
||||
features][4].
|
||||
Thanks for your interest in sponsoring! In order to become an eligible sponsor
|
||||
with your GitHub account, visit [squidfunk's sponsor profile], and complete
|
||||
a sponsorship of __$10 a month or more__. You can use your individual or
|
||||
organization GitHub account for sponsoring.
|
||||
|
||||
__Important__: If you're sponsoring @squidfunk through a GitHub organization,
|
||||
please send a short email to sponsors@squidfunk.com with the name of your
|
||||
organization and the account that should be added as a collaborator.[^3]
|
||||
organization and the GitHub account of the individual that should be added as a
|
||||
collaborator.[^4]
|
||||
|
||||
You can cancel your sponsorship anytime.[^4]
|
||||
You can cancel your sponsorship anytime.[^5]
|
||||
|
||||
[^2]:
|
||||
Note that $10/month is the minimum amount to become eligible for Insiders.
|
||||
If you sponsor with a lower amount, it's still very much appreciated, but
|
||||
you won't be granted access to Insiders. Custom amounts of $10+ are also
|
||||
eligible.
|
||||
|
||||
[^3]:
|
||||
[^4]:
|
||||
It's currently not possible to grant access to each member of an
|
||||
organization, as GitHub only allows for adding users. Thus, after
|
||||
sponsoring, please send an email to sponsors@squidfunk.com, stating which
|
||||
@ -87,7 +107,7 @@ You can cancel your sponsorship anytime.[^4]
|
||||
private Insiders GitHub repository, and grant access to all members of the
|
||||
organizations.
|
||||
|
||||
[^4]:
|
||||
[^5]:
|
||||
If you cancel your sponsorship, GitHub schedules a cancellation request
|
||||
which will become effective at the end of the billing cycle. This means
|
||||
that even though you cancel your sponsorship, you will keep your access to
|
||||
@ -96,7 +116,7 @@ You can cancel your sponsorship anytime.[^4]
|
||||
regarding your payment, and GitHub doesn't offer refunds, sponsorships are
|
||||
non-refundable.
|
||||
|
||||
[:octicons-heart-fill-24:{ .mdx-heart } Join our <span class="mdx-sponsorship-count" data-mdx-component="sponsorship-count"></span> awesome sponsors][5]{ .md-button .md-button--primary .mdx-sponsorship-button }
|
||||
[:octicons-heart-fill-24:{ .mdx-heart } 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 />
|
||||
|
||||
@ -104,19 +124,22 @@ You can cancel your sponsorship anytime.[^4]
|
||||
|
||||
**Special thanks** to our **premium sponsors**:
|
||||
|
||||
[![Manticore Games]](https://www.manticoregames.com/){ target=_blank title="Manticore Games" }
|
||||
[![KX]](https://kx.com/){ target=_blank title="KX Systems" }
|
||||
[![Hummingbot]](https://hummingbot.io/){ target=_blank title="Hummingbot" }
|
||||
[![Basler]](https://docs.baslerweb.com/){ target=_blank title="Basler" }
|
||||
[![Cirrus CI]](https://cirrus-ci.org/){ target=_blank title="Cirrus CI" }
|
||||
[![Basler]](https://docs.baslerweb.com/){ target=_blank title="Basler" }
|
||||
[![Hummingbot]](https://hummingbot.io/){ target=_blank title="Hummingbot" }
|
||||
[![KX]](https://kx.com/){ target=_blank title="KX Systems" }
|
||||
[![Manticore Games]](https://www.manticoregames.com/){ target=_blank title="Manticore Games" }
|
||||
[![Account technologies]](https://www.accounttechnologies.com/){ target=_blank title="Account technologies" }
|
||||
|
||||
</div>
|
||||
|
||||
[Manticore Games]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/manticoregames.png
|
||||
[KX]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/kx.svg
|
||||
[Hummingbot]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/hummingbot.png
|
||||
[Basler]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/basler.png
|
||||
[Cirrus CI]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/cirrus-ci.svg
|
||||
[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
|
||||
[Hummingbot]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-hummingbot.png
|
||||
[KX]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-kx.png
|
||||
[Manticore Games]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-manticore-games.png
|
||||
[Account technologies]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-account-technologies.png
|
||||
|
||||
|
||||
<hr />
|
||||
|
||||
@ -131,163 +154,163 @@ You can cancel your sponsorship anytime.[^4]
|
||||
</small>
|
||||
</div>
|
||||
|
||||
[5]: https://github.com/sponsors/squidfunk
|
||||
[squidfunk's sponsor profile]: https://github.com/sponsors/squidfunk
|
||||
|
||||
## Exclusive features
|
||||
## Available features
|
||||
|
||||
The following features are currently exclusively available to sponsors:
|
||||
The following features are solely available via Material for MkDocs Insiders:
|
||||
|
||||
<div class="mdx-columns" markdown>
|
||||
|
||||
- [x] [Was this page helpful? :material-new-box:][44]
|
||||
- [x] [Brand new search plugin :material-new-box:][35]
|
||||
- [x] [Rich search previews][36]
|
||||
- [x] [Tokenizer with lookahead][37]
|
||||
- [x] [Advanced search highlighting][38]
|
||||
- [x] [Excluding content from search][39]
|
||||
- [x] [Social cards][34]
|
||||
- [x] [Cookie consent][33]
|
||||
- [x] [Linking content tabs][32]
|
||||
- [x] [Boosting pages in search][30]
|
||||
- [x] [Tags (with search integration)][29]
|
||||
- [x] [Stay on page when switching versions][28]
|
||||
- [x] [Version warning][26]
|
||||
- [x] [Custom admonition icons][31]
|
||||
- [x] [Code annotations][25]
|
||||
- [x] [Anchor tracking ][24]
|
||||
- [x] [Mermaid.js integration][27]
|
||||
- [x] [Was this page helpful?] :material-new-box:
|
||||
- [x] [Brand new search plugin] :material-new-box:
|
||||
- [x] [Rich search previews]
|
||||
- [x] [Tokenizer with lookahead]
|
||||
- [x] [Advanced search highlighting]
|
||||
- [x] [Excluding content from search]
|
||||
- [x] [Social cards]
|
||||
- [x] [Cookie consent]
|
||||
- [x] [Linking content tabs]
|
||||
- [x] [Boosting pages in search]
|
||||
- [x] [Tags] with search integration
|
||||
- [x] [Stay on page when switching versions]
|
||||
- [x] [Version warning]
|
||||
- [x] [Custom admonition icons]
|
||||
- [x] [Code annotations]
|
||||
- [x] [Anchor tracking]
|
||||
- [x] [Mermaid.js integration]
|
||||
|
||||
</div>
|
||||
|
||||
_New features are added to this list every few weeks, so be sure to come back
|
||||
from time to time to learn about what's new, or follow [@squidfunk on
|
||||
:fontawesome-brands-twitter:{ .twitter } Twitter][6] to stay updated._
|
||||
|
||||
[6]: https://twitter.com/squidfunk
|
||||
|
||||
## Funding <span class="mdx-sponsorship-total" data-mdx-component="sponsorship-total"></span>
|
||||
|
||||
### Goals
|
||||
|
||||
Following is a list of funding goals. When a funding goal is hit, the features
|
||||
that are tied to it are merged back into Material for MkDocs and released to
|
||||
the public for general availability.
|
||||
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. When the funding goal is hit, the features
|
||||
are released for general availability.
|
||||
|
||||
#### $ 4,000 – Ghost Pepper
|
||||
|
||||
- [x] [Anchor tracking][24]
|
||||
- [x] [Code annotations][25]
|
||||
- [x] [Version warning][26]
|
||||
- [x] [Anchor tracking]
|
||||
- [x] [Code annotations]
|
||||
- [x] [Version warning]
|
||||
|
||||
[24]: ../setup/setting-up-navigation.md#anchor-tracking
|
||||
[25]: ../reference/code-blocks.md#adding-annotations
|
||||
[26]: ../setup/setting-up-versioning.md#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
|
||||
|
||||
#### $ 5,000 – Aji Panca
|
||||
|
||||
- [x] [Mermaid.js integration][27]
|
||||
- [x] [Stay on page when switching versions][28]
|
||||
- [x] [Tags (with search integration)][29]
|
||||
- [x] [Mermaid.js integration]
|
||||
- [x] [Stay on page when switching versions]
|
||||
- [x] [Tags] with search integration
|
||||
|
||||
[27]: ../reference/diagrams.md
|
||||
[28]: ../setup/setting-up-versioning.md#stay-on-page
|
||||
[29]: ../setup/setting-up-tags.md
|
||||
[Mermaid.js integration]: ../reference/diagrams.md
|
||||
[Stay on page when switching versions]: ../setup/setting-up-versioning.md#stay-on-page
|
||||
[Tags]: ../setup/setting-up-tags.md
|
||||
|
||||
#### $ 6,000 – Trinidad Scorpion
|
||||
|
||||
- [x] [Boosting pages in search][30]
|
||||
- [x] [Custom admonition icons][31]
|
||||
- [x] [Linking content tabs][32]
|
||||
- [x] [Boosting pages in search]
|
||||
- [x] [Custom admonition icons]
|
||||
- [x] [Linking content tabs]
|
||||
|
||||
[30]: ../setup/setting-up-site-search.md#search-boosting
|
||||
[31]: ../reference/admonitions.md#admonition-icons
|
||||
[32]: ../reference/content-tabs.md#linked-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
|
||||
|
||||
#### $ 7,000 – Royal Gold
|
||||
|
||||
- [x] [Cookie consent][33]
|
||||
- [x] [Was this page helpful?][44]
|
||||
- [x] [Cookie consent]
|
||||
- [x] [Was this page helpful?]
|
||||
- [ ] Link cards
|
||||
|
||||
[33]: ../setup/setting-up-site-analytics.md#cookie-consent
|
||||
[44]: ../setup/setting-up-site-analytics.md#was-this-page-helpful
|
||||
[Cookie consent]: ../setup/setting-up-site-analytics.md#cookie-consent
|
||||
[Was this page helpful?]: ../setup/setting-up-site-analytics.md#was-this-page-helpful
|
||||
|
||||
#### $ 8,000 – Scotch Bonnet
|
||||
|
||||
- [x] [Social cards][34]
|
||||
- [x] [Social cards]
|
||||
- [ ] Stay on page when switching languages
|
||||
- [ ] Table of contents follows active anchor
|
||||
|
||||
[34]: ../setup/setting-up-social-cards.md
|
||||
[Social cards]: ../setup/setting-up-social-cards.md
|
||||
|
||||
#### $ 10,000 – Carolina Reaper
|
||||
|
||||
- [x] [Brand new search plugin][35]
|
||||
- [x] [Rich search previews][36]
|
||||
- [x] [Tokenizer with lookahead][37]
|
||||
- [x] [Advanced search highlighting][38]
|
||||
- [x] [Excluding content from search][39]
|
||||
- [x] [Brand new search plugin]
|
||||
- [x] [Rich search previews]
|
||||
- [x] [Tokenizer with lookahead]
|
||||
- [x] [Advanced search highlighting]
|
||||
- [x] [Excluding content from search]
|
||||
|
||||
[35]: ../blog/2021/search-better-faster-smaller.md
|
||||
[36]: ../blog/2021/search-better-faster-smaller.md#rich-search-previews
|
||||
[37]: ../blog/2021/search-better-faster-smaller.md#tokenizer-lookahead
|
||||
[38]: ../blog/2021/search-better-faster-smaller.md#accurate-highlighting
|
||||
[39]: ../setup/setting-up-site-search.md#search-exclusion
|
||||
[Brand new search plugin]: ../blog/2021/search-better-faster-smaller.md
|
||||
[Rich search previews]: ../blog/2021/search-better-faster-smaller.md#rich-search-previews
|
||||
[Tokenizer with lookahead]: ../blog/2021/search-better-faster-smaller.md#tokenizer-lookahead
|
||||
[Advanced search highlighting]: ../blog/2021/search-better-faster-smaller.md#accurate-highlighting
|
||||
[Excluding content from search]: ../setup/setting-up-site-search.md#search-exclusion
|
||||
|
||||
### Goals completed
|
||||
|
||||
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.
|
||||
|
||||
#### $ 3,000 – Caribbean Red
|
||||
|
||||
- [x] [Sticky navigation tabs][21]
|
||||
- [x] [Section index pages][22]
|
||||
- [x] [Remove generator notice][23]
|
||||
- [x] [Sticky navigation tabs]
|
||||
- [x] [Section index pages]
|
||||
- [x] [Remove generator notice]
|
||||
|
||||
[21]: ../setup/setting-up-navigation.md#sticky-navigation-tabs
|
||||
[22]: ../setup/setting-up-navigation.md#section-index-pages
|
||||
[23]: ../setup/setting-up-the-footer.md#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][18]
|
||||
- [x] [Search highlighting][19]
|
||||
- [x] [Search sharing][20]
|
||||
- [x] [Search suggestions]
|
||||
- [x] [Search highlighting]
|
||||
- [x] [Search sharing]
|
||||
|
||||
[18]: ../setup/setting-up-site-search.md#search-suggestions
|
||||
[19]: ../setup/setting-up-site-search.md#search-highlighting
|
||||
[20]: ../setup/setting-up-site-search.md#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][16]
|
||||
- [x] [Back-to-top button][17]
|
||||
- [x] [Color palette toggle]
|
||||
- [x] [Back-to-top button]
|
||||
|
||||
[16]: ../setup/changing-the-colors.md#color-palette-toggle
|
||||
[17]: ../setup/setting-up-navigation.md#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][12]
|
||||
- [x] [Site language selection][13]
|
||||
- [x] [Versioning][14]
|
||||
- [x] [Admonition inline blocks]
|
||||
- [x] [Site language selection]
|
||||
- [x] [Versioning]
|
||||
|
||||
[12]: ../reference/admonitions.md#inline-blocks
|
||||
[13]: ../setup/changing-the-language.md#site-language-selector
|
||||
[14]: ../setup/setting-up-versioning.md#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][7]
|
||||
- [x] [Navigation expansion][8]
|
||||
- [x] [Hiding the sidebars][9]
|
||||
- [x] [Table of contents in navigation][10]
|
||||
- [x] [Header hides on scroll][11]
|
||||
- [x] [Navigation sections]
|
||||
- [x] [Navigation expansion]
|
||||
- [x] [Hiding the sidebars]
|
||||
- [x] [Table of contents in navigation]
|
||||
- [x] [Header hides on scroll]
|
||||
|
||||
[7]: ../setup/setting-up-navigation.md#navigation-sections
|
||||
[8]: ../setup/setting-up-navigation.md#navigation-expansion
|
||||
[9]: ../setup/setting-up-navigation.md#hiding-the-sidebars
|
||||
[10]: ../setup/setting-up-navigation.md#navigation-integration
|
||||
[11]: ../setup/setting-up-the-header.md#automatic-hiding
|
||||
[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
|
||||
|
||||
@ -299,53 +322,59 @@ the public for general availability.
|
||||
|
||||
### Compatibility
|
||||
|
||||
_We're running an open source project and want to make sure that users can build
|
||||
the documentation without having access to Insiders. Is this still possible?_
|
||||
_We're running an open source project and want to make sure that users can
|
||||
change and build the documentation without having access to Insiders. Is this
|
||||
still possible?_
|
||||
|
||||
Yes. Insiders is compatible with Material for MkDocs. All new features are
|
||||
implemented behind feature flags; all configuration changes are
|
||||
backward-compatible. This means that your users will be able to build the
|
||||
Yes. Insiders is compatible with Material for MkDocs. Almost all new features
|
||||
are implemented behind feature flags; almost all configuration changes are
|
||||
backward-compatible. This means that developers will be able to build the
|
||||
documentation locally with Material for MkDocs and when they push their changes,
|
||||
it can be built with Insiders (e.g. as part of GitHub Actions). Thus, it's
|
||||
recommended to [install Insiders][40] only in CI, as you don't want to expose
|
||||
your `GH_TOKEN` to users.
|
||||
it can be built with Insiders (e.g. as part of GitHub Actions).
|
||||
|
||||
[40]: ../publishing-your-site.md#github-pages
|
||||
When using built-in plugins that are solely available via Insiders, it might be
|
||||
necessary to split the `mkdocs.yml` configuration into a base configuration, and
|
||||
one with plugin overrides. Note that this is a limitation of MkDocs, which can
|
||||
be mitigated by using [configuration inheritance].
|
||||
|
||||
See the [getting started guide] for more information.
|
||||
|
||||
[configuration inheritance]: https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance
|
||||
[getting started guide]: getting-started.md
|
||||
|
||||
### 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
|
||||
yearly billing cycle][41]. 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).
|
||||
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).
|
||||
|
||||
If you have any problems or further questions, don't hesitate to contact me at
|
||||
sponsors@squidfunk.com. Note that one-time payments are not eligible for
|
||||
Insiders, but of course, very appreciated.
|
||||
If you have any problems or further questions, please reach out to
|
||||
sponsors@squidfunk.com.
|
||||
|
||||
[41]: https://docs.github.com/en/github/setting-up-and-managing-billing-and-payments-on-github/changing-the-duration-of-your-billing-cycle
|
||||
[billing cycle]: https://docs.github.com/en/github/setting-up-and-managing-billing-and-payments-on-github/changing-the-duration-of-your-billing-cycle
|
||||
|
||||
### Terms
|
||||
|
||||
_We're using Material for MkDocs to build the developer documentation of a
|
||||
commercial project. Can we use Insiders under the same terms and conditions?_
|
||||
_Are we allowed to use Insiders under the same terms and conditions as
|
||||
Material for MkDocs?_
|
||||
|
||||
Yes. Whether you're an individual or a company, you may use _Material for MkDocs
|
||||
Insiders_ precisely under the same terms as Material for MkDocs, which are given
|
||||
by the [MIT license][42]. However, we kindly ask you to respect the following
|
||||
by the [MIT license]. However, we kindly ask you to respect the following
|
||||
guidelines:
|
||||
|
||||
- Please __don't distribute the source code__ of Insiders. You may freely use
|
||||
it for public, private or commercial projects, fork it, mirror it, do whatever
|
||||
you want with it, but please don't release the source code, as it would
|
||||
counteract the sponsorware strategy.
|
||||
it for public, private or commercial projects, privately fork or mirror it,
|
||||
but please don't make the source code public, as it would counteract the
|
||||
sponsorware strategy.
|
||||
|
||||
- If you cancel your subscription, you're removed as a collaborator and will
|
||||
miss out on 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][43].
|
||||
- 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].
|
||||
|
||||
[42]: ../license.md
|
||||
[43]: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository
|
||||
[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
|
||||
|
||||
@ -145,9 +145,10 @@ language of the block can be placed, e.g. for JavaScript in `#!js // ...` and
|
||||
|
||||
[^1]:
|
||||
Code annotations require syntax highlighting with [Pygments] – they're
|
||||
currently not compatible with JavaScript syntax highlighters. Support will
|
||||
be added at a later point, allowing to always place code annotations at the
|
||||
end of lines.
|
||||
currently not compatible with JavaScript syntax highlighters, or languages
|
||||
that do not have comments in their grammar. However, we're actively working
|
||||
on supporting alternate ways of defining code annotations, allowing to
|
||||
always place code annotations at the end of lines.
|
||||
|
||||
_Example_:
|
||||
|
||||
|
||||
@ -158,15 +158,19 @@ No configuration options are available. See reference for usage:
|
||||
|
||||
- [Setting the page title]
|
||||
- [Setting the page description]
|
||||
- [Hiding the sidebars]
|
||||
- [Adding tags]
|
||||
- [Hiding the tags]
|
||||
- [Hiding the sidebars]
|
||||
- [Hiding the feedback widget]
|
||||
|
||||
[Metadata]: https://python-markdown.github.io/extensions/meta_data/
|
||||
[Metadata support]: https://github.com/squidfunk/mkdocs-material/releases/tag/1.0.0
|
||||
[Setting the page title]: ../../reference/meta-tags.md#setting-the-page-title
|
||||
[Setting the page description]: ../../reference/meta-tags.md#setting-the-page-description
|
||||
[Hiding the sidebars]: ../../setup/setting-up-navigation.md#hiding-the-sidebars
|
||||
[Adding tags]: ../../setup/setting-up-tags.md#adding-tags
|
||||
[Hiding the tags]: ../../setup/setting-up-tags.md#hiding-the-tags
|
||||
[Hiding the sidebars]: ../../setup/setting-up-navigation.md#hiding-the-sidebars
|
||||
[Hiding the feedback widget]: ../../setup/setting-up-site-analytics.md#hiding-the-feedback-widget
|
||||
|
||||
### Markdown in HTML
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@ matches the new structure:
|
||||
- If you've overridden a __template__, check the respective `*.html` file for
|
||||
potential changes
|
||||
|
||||
=== ":octicons-file-code-24: base.html"
|
||||
=== ":octicons-file-code-16: base.html"
|
||||
|
||||
``` diff
|
||||
@@ -61,7 +61,7 @@
|
||||
@ -149,7 +149,7 @@ matches the new structure:
|
||||
{% endfor %}
|
||||
```
|
||||
|
||||
=== ":octicons-file-code-24: partials/footer.html"
|
||||
=== ":octicons-file-code-16: partials/footer.html"
|
||||
|
||||
``` diff
|
||||
- <div class="md-footer-nav">
|
||||
@ -221,7 +221,7 @@ matches the new structure:
|
||||
<div class="md-footer-meta__inner md-grid">
|
||||
```
|
||||
|
||||
=== ":octicons-file-code-24: partials/header.html"
|
||||
=== ":octicons-file-code-16: partials/header.html"
|
||||
|
||||
``` diff
|
||||
@@ -6,21 +6,21 @@
|
||||
@ -294,7 +294,7 @@ matches the new structure:
|
||||
|
||||
```
|
||||
|
||||
=== ":octicons-file-code-24: partials/source.html"
|
||||
=== ":octicons-file-code-16: partials/source.html"
|
||||
|
||||
``` diff
|
||||
@@ -4,5 +4,5 @@
|
||||
@ -306,7 +306,7 @@ matches the new structure:
|
||||
{% include ".icons/" ~ icon ~ ".svg" %}
|
||||
```
|
||||
|
||||
=== ":octicons-file-code-24: partials/toc.html"
|
||||
=== ":octicons-file-code-16: partials/toc.html"
|
||||
|
||||
``` diff
|
||||
@@ -12,7 +12,7 @@
|
||||
@ -378,7 +378,7 @@ matches the new structure:
|
||||
- If you've overridden a __template__, check the respective `*.html` file for
|
||||
potential changes
|
||||
|
||||
=== ":octicons-file-code-24: base.html"
|
||||
=== ":octicons-file-code-16: base.html"
|
||||
|
||||
``` diff
|
||||
@@ -22,13 +22,6 @@
|
||||
@ -548,7 +548,7 @@ matches the new structure:
|
||||
{%- endfor -%}
|
||||
```
|
||||
|
||||
=== ":octicons-file-code-24: partials/hero.html"
|
||||
=== ":octicons-file-code-16: partials/hero.html"
|
||||
|
||||
``` diff
|
||||
@@ -1,12 +0,0 @@
|
||||
@ -566,7 +566,7 @@ matches the new structure:
|
||||
-</div>
|
||||
```
|
||||
|
||||
=== ":octicons-file-code-24: partials/source-link"
|
||||
=== ":octicons-file-code-16: partials/source-link"
|
||||
|
||||
``` diff
|
||||
-{#-
|
||||
@ -739,7 +739,7 @@ matches the new structure:
|
||||
- If you've overridden a __template__, check the respective `*.html` file for
|
||||
potential changes
|
||||
|
||||
=== ":octicons-file-code-24: base.html"
|
||||
=== ":octicons-file-code-16: base.html"
|
||||
|
||||
``` diff
|
||||
@@ -2,7 +2,6 @@
|
||||
@ -990,7 +990,7 @@ matches the new structure:
|
||||
{% endfor %}
|
||||
```
|
||||
|
||||
=== ":octicons-file-code-24: partials/footer.html"
|
||||
=== ":octicons-file-code-16: partials/footer.html"
|
||||
|
||||
``` diff
|
||||
@@ -5,34 +5,34 @@
|
||||
@ -1041,7 +1041,7 @@ matches the new structure:
|
||||
{% endif %}
|
||||
```
|
||||
|
||||
=== ":octicons-file-code-24: partials/header.html"
|
||||
=== ":octicons-file-code-16: partials/header.html"
|
||||
|
||||
``` diff
|
||||
@@ -2,51 +2,43 @@
|
||||
@ -1132,7 +1132,7 @@ matches the new structure:
|
||||
</header>
|
||||
```
|
||||
|
||||
=== ":octicons-file-code-24: partials/hero.html"
|
||||
=== ":octicons-file-code-16: partials/hero.html"
|
||||
|
||||
``` diff
|
||||
@@ -1,9 +1,8 @@
|
||||
@ -1148,7 +1148,7 @@ matches the new structure:
|
||||
<div class="{{ class }}" data-md-component="hero">
|
||||
```
|
||||
|
||||
=== ":octicons-file-code-24: partials/language.html"
|
||||
=== ":octicons-file-code-16: partials/language.html"
|
||||
|
||||
``` diff
|
||||
@@ -3,12 +3,4 @@
|
||||
@ -1167,7 +1167,7 @@ matches the new structure:
|
||||
+{% macro t(key) %}{{ lang.t(key) | default(fallback.t(key)) }}{% endmacro %}
|
||||
```
|
||||
|
||||
=== ":octicons-file-code-24: partials/logo.html"
|
||||
=== ":octicons-file-code-16: partials/logo.html"
|
||||
|
||||
``` diff
|
||||
@@ -0,0 +1,9 @@
|
||||
@ -1182,7 +1182,7 @@ matches the new structure:
|
||||
+{% endif %}
|
||||
```
|
||||
|
||||
=== ":octicons-file-code-24: partials/nav-item.html"
|
||||
=== ":octicons-file-code-16: partials/nav-item.html"
|
||||
|
||||
``` diff
|
||||
@@ -14,9 +14,15 @@
|
||||
@ -1214,7 +1214,7 @@ matches the new structure:
|
||||
<a href="{{ nav_item.url | url }}" title="{{ nav_item.title | striptags }}" class="md-nav__link md-nav__link--active">
|
||||
```
|
||||
|
||||
=== ":octicons-file-code-24: partials/nav.html"
|
||||
=== ":octicons-file-code-16: partials/nav.html"
|
||||
|
||||
``` diff
|
||||
@@ -1,14 +1,10 @@
|
||||
@ -1238,7 +1238,7 @@ matches the new structure:
|
||||
</label>
|
||||
```
|
||||
|
||||
=== ":octicons-file-code-24: partials/search.html"
|
||||
=== ":octicons-file-code-16: partials/search.html"
|
||||
|
||||
``` diff
|
||||
@@ -6,15 +6,18 @@
|
||||
@ -1266,7 +1266,7 @@ matches the new structure:
|
||||
</div>
|
||||
```
|
||||
|
||||
=== ":octicons-file-code-24: partials/social.html"
|
||||
=== ":octicons-file-code-16: partials/social.html"
|
||||
|
||||
``` diff
|
||||
@@ -3,9 +3,12 @@
|
||||
@ -1286,7 +1286,7 @@ matches the new structure:
|
||||
{% endif %}
|
||||
```
|
||||
|
||||
=== ":octicons-file-code-24: partials/source-date.html"
|
||||
=== ":octicons-file-code-16: partials/source-date.html"
|
||||
|
||||
``` diff
|
||||
@@ -0,0 +1,15 @@
|
||||
@ -1307,7 +1307,7 @@ matches the new structure:
|
||||
+</div>
|
||||
```
|
||||
|
||||
=== ":octicons-file-code-24: partials/source-link.html"
|
||||
=== ":octicons-file-code-16: partials/source-link.html"
|
||||
|
||||
``` diff
|
||||
@@ -0,0 +1,13 @@
|
||||
@ -1326,7 +1326,7 @@ matches the new structure:
|
||||
+</a>
|
||||
```
|
||||
|
||||
=== ":octicons-file-code-24: partials/source.html"
|
||||
=== ":octicons-file-code-16: partials/source.html"
|
||||
|
||||
``` diff
|
||||
@@ -2,24 +2,11 @@
|
||||
@ -1361,7 +1361,7 @@ matches the new structure:
|
||||
</div>
|
||||
```
|
||||
|
||||
=== ":octicons-file-code-24: partials/tabs-item.html"
|
||||
=== ":octicons-file-code-16: partials/tabs-item.html"
|
||||
|
||||
``` diff
|
||||
@@ -1,7 +1,7 @@
|
||||
@ -1375,7 +1375,7 @@ matches the new structure:
|
||||
<a href="{{ nav_item.url | url }}" class="md-tabs__link md-tabs__link--active">
|
||||
```
|
||||
|
||||
=== ":octicons-file-code-24: partials/tabs.html"
|
||||
=== ":octicons-file-code-16: partials/tabs.html"
|
||||
|
||||
``` diff
|
||||
@@ -5,7 +5,7 @@
|
||||
@ -1389,7 +1389,7 @@ matches the new structure:
|
||||
{% for nav_item in nav %}
|
||||
```
|
||||
|
||||
=== ":octicons-file-code-24: partials/toc-item.html"
|
||||
=== ":octicons-file-code-16: partials/toc-item.html"
|
||||
|
||||
``` diff
|
||||
@@ -6,7 +6,7 @@
|
||||
@ -1403,7 +1403,7 @@ matches the new structure:
|
||||
{% include "partials/toc-item.html" %}
|
||||
```
|
||||
|
||||
=== ":octicons-file-code-24: partials/toc.html"
|
||||
=== ":octicons-file-code-16: partials/toc.html"
|
||||
|
||||
``` diff
|
||||
@@ -2,35 +2,22 @@
|
||||
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -3,7 +3,7 @@
|
||||
-#}
|
||||
{% extends "base.html" %}
|
||||
{% block extrahead %}
|
||||
<link rel="stylesheet" href="{{ 'overrides/assets/stylesheets/main.12078483.min.css' | url }}">
|
||||
<link rel="stylesheet" href="{{ 'overrides/assets/stylesheets/main.bf3dc0a9.min.css' | url }}">
|
||||
{% endblock %}
|
||||
{% block announce %}
|
||||
<a href="https://twitter.com/squidfunk">
|
||||
@ -16,5 +16,5 @@
|
||||
{% endblock %}
|
||||
{% block scripts %}
|
||||
{{ super() }}
|
||||
<script src="{{ 'overrides/assets/javascripts/bundle.fa9f9d04.min.js' | url }}"></script>
|
||||
<script src="{{ 'overrides/assets/javascripts/bundle.619e2917.min.js' | url }}"></script>
|
||||
{% endblock %}
|
||||
|
||||
@ -139,7 +139,7 @@ export function mountSponsorship(
|
||||
total.innerText = `$ ${sponsorship.total
|
||||
.toString()
|
||||
.replace(/\B(?=(\d{3})+(?!\d))/g, ",")
|
||||
}`
|
||||
} a month`
|
||||
})
|
||||
|
||||
// /* Create and return component */
|
||||
|
||||
@ -38,7 +38,7 @@
|
||||
|
||||
// Premium sponsor image
|
||||
img {
|
||||
height: px2rem(60px);
|
||||
height: px2rem(65px);
|
||||
}
|
||||
|
||||
// Premium sponsor list
|
||||
@ -51,14 +51,6 @@
|
||||
> a {
|
||||
display: block;
|
||||
flex-shrink: 0;
|
||||
padding: px2rem(10px) px2rem(20px);
|
||||
transition: transform 125ms;
|
||||
|
||||
// Premium sponsor item on focus/hover
|
||||
&:focus,
|
||||
&:hover {
|
||||
transform: scale(1.1);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -82,8 +74,8 @@
|
||||
&__item {
|
||||
display: block;
|
||||
float: left;
|
||||
width: px2rem(60px);
|
||||
height: px2rem(60px);
|
||||
width: px2rem(32px);
|
||||
height: px2rem(32px);
|
||||
margin: px2rem(4px);
|
||||
overflow: hidden;
|
||||
border-radius: 100%;
|
||||
@ -107,8 +99,8 @@
|
||||
&--private {
|
||||
color: var(--md-default-fg-color--lighter);
|
||||
font-weight: 700;
|
||||
font-size: px2rem(24px);
|
||||
line-height: px2rem(60px);
|
||||
font-size: px2rem(12px);
|
||||
line-height: px2rem(32px);
|
||||
text-align: center;
|
||||
background: var(--md-default-fg-color--lightest);
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user