Documentation

This commit is contained in:
squidfunk 2022-04-28 11:16:09 +02:00
parent a8cb5d0abb
commit 60b8ab8703
2 changed files with 12 additions and 9 deletions

View File

@ -8,8 +8,7 @@ title: Insiders
Material for MkDocs follows the __sponsorware__ release strategy, which means Material for MkDocs follows the __sponsorware__ release strategy, which means
that new features are first exclusively released to sponsors as part of that new features are first exclusively released to sponsors as part of
[Insiders]. Read on to learn [what sponsorships achieve], [Insiders]. Read on to learn [what sponsorships achieve],
[how to become a sponsor] to get access to Insiders, and [how to become a sponsor] to get access to Insiders, and [what's in for you]!
[what's in for you][available features]!
<figure class="mdx-video" markdown> <figure class="mdx-video" markdown>
<div class="mdx-video__inner"> <div class="mdx-video__inner">
@ -26,15 +25,16 @@ This documentation is built with Insiders
[Insiders]: #what-is-insiders [Insiders]: #what-is-insiders
[what sponsorships achieve]: #what-sponsorships-achieve [what sponsorships achieve]: #what-sponsorships-achieve
[how to become a sponsor]: #how-to-become-a-sponsor [how to become a sponsor]: #how-to-become-a-sponsor
[available features]: #available-features [what's in for you]: #whats-in-for-me
[Material for MkDocs]: https://squidfunk.github.io/mkdocs-material/ [Material for MkDocs]: https://squidfunk.github.io/mkdocs-material/
## What is Insiders? ## What is Insiders?
Material for MkDocs Insiders is a private fork of Material for MkDocs, hosted as 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 a private GitHub repository. Almost[^1] [all new features][what's in for you]
this fork, which means that they are immediately available to all eligible are developed as part of this fork, which means that they are immediately
sponsors, as they are made collaborators of this repository. available to all eligible sponsors, as they are made collaborators of this
repository.
[^1]: [^1]:
In general, every new feature is first exclusively released to sponsors, but In general, every new feature is first exclusively released to sponsors, but
@ -166,9 +166,11 @@ You can cancel your sponsorship anytime.[^5]
[squidfunk's sponsor profile]: https://github.com/sponsors/squidfunk [squidfunk's sponsor profile]: https://github.com/sponsors/squidfunk
## Available features ## What's in for me?
The following features are solely available via Material for MkDocs Insiders: The moment you [become a sponsor][how to become a sponsor], you'll get __immediate
access to many additional features__ that you can start using right away, and
which are currently exclusively available to sponsors:
<div class="mdx-columns" markdown> <div class="mdx-columns" markdown>

View File

@ -90,7 +90,7 @@ List elements can contain arbitrary Markdown, as long as the surrounding `div`
defines the `markdown` attribute. Following is a more complex example, which defines the `markdown` attribute. Following is a more complex example, which
includes icons and links: includes icons and links:
``` html title="Grid with cards, complex example" ``` html title="Card grid, complex example"
<div class="grid cards" markdown> <div class="grid cards" markdown>
- :material-clock-fast:{ .lg .middle } __Set up in 5 minutes__ - :material-clock-fast:{ .lg .middle } __Set up in 5 minutes__
@ -264,6 +264,7 @@ by using a `div` with the `grid` class:
2. Donec vitae suscipit est 2. Donec vitae suscipit est
3. Nulla tempor lobortis orci 3. Nulla tempor lobortis orci
``` ```
</div> </div>
```` ````