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

Documentation

Browse Source
This commit is contained in:
squidfunk 2022-12-10 12:37:41 +01:00
parent 9827e261b9
commit 397edd9ae9
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -58,7 +58,7 @@ theme:
2. Add the schema under the `yaml.schemas` key in your user or 2. Add the schema under the `yaml.schemas` key in your user or
workspace [`settings.json`][settings.json]: workspace [`settings.json`][settings.json]:
``` { .json .annotate } ``` json
{ {
"yaml.schemas": { "yaml.schemas": {
"https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml" "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
@ -71,12 +71,13 @@ theme:
} }
``` ```
1. `yaml.customTags` part will be needed if you want to use and configure [Emojis](reference/icons-emojis.md). 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
@ -96,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