diff --git a/docs/creating-your-site.md b/docs/creating-your-site.md index c8123802b..4a4971c48 100644 --- a/docs/creating-your-site.md +++ b/docs/creating-your-site.md @@ -62,14 +62,22 @@ theme: { "yaml.schemas": { "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" - 1. Ensure your editor of choice has support for YAML schema validation. - 2. Add the following lines at the top of `mkdocs.yml`: + 3. Ensure your editor of choice has support for YAML schema validation. + 4. Add the following lines at the top of `mkdocs.yml`: ``` yaml # 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 [plugin]: https://github.com/squidfunk/mkdocs-material/tree/master/docs/schema/plugins [$ref]: https://json-schema.org/understanding-json-schema/structuring.html#ref + [icons and emojis]: reference/icons-emojis.md ### Advanced configuration diff --git a/docs/insiders/index.md b/docs/insiders/index.md index 37cc91158..7f43af644 100644 --- a/docs/insiders/index.md +++ b/docs/insiders/index.md @@ -7,7 +7,7 @@ title: 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 [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]!