From a0d87460ee2ad00909319cf4cde8e31f19660460 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sun, 17 Jul 2022 16:36:42 +0200 Subject: [PATCH] Updated JSON schema --- docs/schema/plugins.json | 3 +++ docs/schema/plugins/meta.json | 31 +++++++++++++++++++++++++++++++ docs/schema/plugins/offline.json | 4 ++-- docs/schema/plugins/privacy.json | 4 ++-- docs/schema/plugins/search.json | 4 ++-- docs/schema/plugins/social.json | 4 ++-- docs/schema/plugins/tags.json | 4 ++-- 7 files changed, 44 insertions(+), 10 deletions(-) create mode 100644 docs/schema/plugins/meta.json diff --git a/docs/schema/plugins.json b/docs/schema/plugins.json index d5f60005a..66c6a7459 100644 --- a/docs/schema/plugins.json +++ b/docs/schema/plugins.json @@ -22,6 +22,9 @@ "built-in": { "description": "Built-in plugins", "oneOf": [ + { + "$ref": "plugins/meta.json" + }, { "$ref": "plugins/offline.json" }, diff --git a/docs/schema/plugins/meta.json b/docs/schema/plugins/meta.json new file mode 100644 index 000000000..d1d9cb1b0 --- /dev/null +++ b/docs/schema/plugins/meta.json @@ -0,0 +1,31 @@ +{ + "$schema": "https://json-schema.org/draft-07/schema", + "title": "Built-in meta plugin", + "oneOf": [ + { + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/#built-in-meta-plugin", + "enum": [ + "meta" + ] + }, + { + "type": "object", + "properties": { + "meta": { + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/#built-in-meta-plugin", + "type": "object", + "properties": { + "meta_file": { + "title": "Meta file name", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/#meta-file", + "pattern": "\\.yml$", + "default": "\"**/.meta.yml\"" + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false + } + ] +} diff --git a/docs/schema/plugins/offline.json b/docs/schema/plugins/offline.json index daa53b716..36281cad2 100644 --- a/docs/schema/plugins/offline.json +++ b/docs/schema/plugins/offline.json @@ -3,7 +3,7 @@ "title": "Built-in offline plugin", "oneOf": [ { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-for-offline-usage/", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-for-offline-usage/#built-in-offline-plugin", "enum": [ "offline" ] @@ -12,7 +12,7 @@ "type": "object", "properties": { "offline": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-for-offline-usage/", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-for-offline-usage/#built-in-offline-plugin", "type": "object", "properties": { "enabled": { diff --git a/docs/schema/plugins/privacy.json b/docs/schema/plugins/privacy.json index a2af61182..d229704d5 100644 --- a/docs/schema/plugins/privacy.json +++ b/docs/schema/plugins/privacy.json @@ -3,7 +3,7 @@ "title": "Built-in privacy plugin", "oneOf": [ { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#built-in-privacy-plugin", "enum": [ "privacy" ] @@ -12,7 +12,7 @@ "type": "object", "properties": { "privacy": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#built-in-privacy-plugin", "type": "object", "properties": { "enabled": { diff --git a/docs/schema/plugins/search.json b/docs/schema/plugins/search.json index 0470dc163..ce4892090 100644 --- a/docs/schema/plugins/search.json +++ b/docs/schema/plugins/search.json @@ -3,7 +3,7 @@ "title": "Built-in search plugin", "oneOf": [ { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#built-in-search-plugin", "enum": [ "search" ] @@ -12,7 +12,7 @@ "type": "object", "properties": { "search": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#built-in-search-plugin", "type": "object", "properties": { "lang": { diff --git a/docs/schema/plugins/social.json b/docs/schema/plugins/social.json index f68deb305..e70c9cc8a 100644 --- a/docs/schema/plugins/social.json +++ b/docs/schema/plugins/social.json @@ -3,7 +3,7 @@ "title": "Built-in social plugin", "oneOf": [ { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#built-in-social-plugin", "enum": [ "social" ] @@ -12,7 +12,7 @@ "type": "object", "properties": { "social": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#built-in-social-plugin", "type": "object", "properties": { "cards": { diff --git a/docs/schema/plugins/tags.json b/docs/schema/plugins/tags.json index 3688d73e1..5a7ab1aa8 100644 --- a/docs/schema/plugins/tags.json +++ b/docs/schema/plugins/tags.json @@ -3,7 +3,7 @@ "title": "Built-in tags plugin", "oneOf": [ { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#built-in-tags-plugin", "enum": [ "tags" ] @@ -12,7 +12,7 @@ "type": "object", "properties": { "tags": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#built-in-tags-plugin", "type": "object", "properties": { "tags_file": {