diff --git a/docs/creating-your-site.md b/docs/creating-your-site.md index be041e9fe..3f4bca074 100644 --- a/docs/creating-your-site.md +++ b/docs/creating-your-site.md @@ -95,8 +95,8 @@ slightly different: ???+ tip "Recommended: [configuration validation and auto-complete]" In order to minimize friction and maximize productivity, Material for MkDocs - provides its own [schema.json] for `mkdocs.yml`. If your editor supports - YAML schema validation, it's definitely recommended to set it up: + provides its own [schema.json][^1] for `mkdocs.yml`.[^2] If your editor + supports YAML schema validation, it's definitely recommended to set it up: === "Visual Studio Code" @@ -121,11 +121,20 @@ slightly different: # 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 [schema.json]: schema.json [vscode-yaml]: https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml [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