OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' into feature/material-v9

Browse Source
This commit is contained in:
squidfunk
2022-12-11 10:41:03 +01:00
parent 7bc7b4dae9 397edd9ae9
commit ac7591260f
2 changed files with 16 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/creating-your-site.md
View File

@@ -62,14 +62,22 @@ theme:
{ {
"yaml.schemas": { "yaml.schemas": {
"https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml" "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
} },
"yaml.customTags": [ // (1)!
"tag:yaml.org,2002:python/name:materialx.emoji.to_svg",
"tag:yaml.org,2002:python/name:materialx.emoji.twemoji",
"tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
]
} }
``` ```
1. This setting is necessary if you plan to use [icons and emojis],
or Visual Studio Code will show errors on certain lines.
=== "Other" === "Other"
1. Ensure your editor of choice has support for YAML schema validation. 3. Ensure your editor of choice has support for YAML schema validation.
2. Add the following lines at the top of `mkdocs.yml`: 4. Add the following lines at the top of `mkdocs.yml`:
``` yaml ``` yaml
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json # yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
@@ -89,6 +97,7 @@ theme:
[extension]: https://github.com/squidfunk/mkdocs-material/tree/master/docs/schema/extensions [extension]: https://github.com/squidfunk/mkdocs-material/tree/master/docs/schema/extensions
[plugin]: https://github.com/squidfunk/mkdocs-material/tree/master/docs/schema/plugins [plugin]: https://github.com/squidfunk/mkdocs-material/tree/master/docs/schema/plugins
[$ref]: https://json-schema.org/understanding-json-schema/structuring.html#ref [$ref]: https://json-schema.org/understanding-json-schema/structuring.html#ref
[icons and emojis]: reference/icons-emojis.md
### Advanced configuration ### Advanced configuration

8
docs/insiders/index.md
View File

@@ -7,7 +7,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 [what's in for you]! [how to become a sponsor] to get access to Insiders, and [what's in it for you]!
<!-- <figure class="mdx-video" markdown> <!-- <figure class="mdx-video" markdown>
<div class="mdx-video__inner"> <div class="mdx-video__inner">
@@ -24,13 +24,13 @@ 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
[what's in for you]: #whats-in-for-me [what's in it for you]: #whats-in-it-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][what's in for you] a private GitHub repository. Almost[^1] [all new features][what's in it for you]
are developed as part of this fork, which means that they are immediately 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 available to all eligible sponsors, as they are made collaborators of this
repository. repository.
@@ -78,7 +78,7 @@ a handful of them, [thanks to our awesome sponsors]!
[completed funding goals]: #goals-completed [completed funding goals]: #goals-completed
[thanks to our awesome sponsors]: #how-to-become-a-sponsor [thanks to our awesome sponsors]: #how-to-become-a-sponsor
## What's in for me? ## What's in it for me?
The moment you [become a sponsor][how to become a sponsor], you'll get __immediate The moment you [become a sponsor][how to become a sponsor], you'll get __immediate
access to 19 additional features__ that you can start using right away, and access to 19 additional features__ that you can start using right away, and