Cool_Tools/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2025-02-20 03:51:12 +01:00
Code Issues Releases Wiki Activity

Documentation

Browse Source
This commit is contained in:
squidfunk 2022-01-30 18:29:34 +01:00
parent dd21aabd68
commit 58dfa1b8d9
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -95,8 +95,8 @@ slightly different:
???+ tip "Recommended: [configuration validation and auto-complete]" ???+ tip "Recommended: [configuration validation and auto-complete]"
In order to minimize friction and maximize productivity, Material for MkDocs In order to minimize friction and maximize productivity, Material for MkDocs
provides its own [schema.json] for `mkdocs.yml`. If your editor supports provides its own [schema.json][^1] for `mkdocs.yml`.[^2] If your editor
YAML schema validation, it's definitely recommended to set it up: supports YAML schema validation, it's definitely recommended to set it up:
=== "Visual Studio Code" === "Visual Studio Code"
@ -121,11 +121,20 @@ slightly different:
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json # yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
``` ```
[^1]:
If you're a MkDocs plugin or Markdown extension author and your project
works with Material for MkDocs, you're very much invited to contribute a
schema for your [extension] or [plugin] as part of a pull request on GitHub.
If you already have a schema defined, or wish to self-host your schema to
reduce duplication, you can add it via [$ref].
[configuration validation and auto-complete]: https://twitter.com/squidfunk/status/1487746003692400642 [configuration validation and auto-complete]: https://twitter.com/squidfunk/status/1487746003692400642
[schema.json]: schema.json [schema.json]: schema.json
[vscode-yaml]: https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml [vscode-yaml]: https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml
[settings.json]: https://code.visualstudio.com/docs/getstarted/settings [settings.json]: https://code.visualstudio.com/docs/getstarted/settings
[LSP-yaml]: https://github.com/sublimelsp/LSP-yaml [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
### Advanced configuration ### Advanced configuration