From 551bb9e52692cffcd375abffbb9986be79f43781 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Mazzucotelli?= Date: Sun, 11 Dec 2022 18:13:01 +0100 Subject: [PATCH 1/2] Allow attribute-less use of pymdownx.emoji and pymdownx.tasklist --- docs/schema/extensions/pymdownx.json | 104 ++++++++++++++++----------- 1 file changed, 63 insertions(+), 41 deletions(-) diff --git a/docs/schema/extensions/pymdownx.json b/docs/schema/extensions/pymdownx.json index 19b2e5e7b..1ffe46d80 100644 --- a/docs/schema/extensions/pymdownx.json +++ b/docs/schema/extensions/pymdownx.json @@ -150,47 +150,58 @@ ] }, { - "type": "object", - "properties": { - "pymdownx.emoji": { + "oneOf": [ + { "title": "Emoji – Python Markdown Extensions", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#emoji", + "enum": [ + "pymdownx.emoji" + ] + }, + { "type": "object", "properties": { - "emoji_generator": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.emoji_generator", - "default": "!!python/name:materialx.emoji.to_svg" - }, - "emoji_index": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.emoji_index", - "default": "!!python/name:materialx.emoji.twemoji" - }, - "options": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.options.custom_icons", + "pymdownx.emoji": { + "title": "Emoji – Python Markdown Extensions", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#emoji", "type": "object", "properties": { - "custom_icons": { + "emoji_generator": { + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.emoji_generator", + "default": "!!python/name:materialx.emoji.to_svg" + }, + "emoji_index": { + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.emoji_index", + "default": "!!python/name:materialx.emoji.twemoji" + }, + "options": { "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.options.custom_icons", - "type": "array", - "items": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.options.custom_icons", - "type": "string" + "type": "object", + "properties": { + "custom_icons": { + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.options.custom_icons", + "type": "array", + "items": { + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.options.custom_icons", + "type": "string" + }, + "uniqueItems": true, + "minItems": 1 + } }, - "uniqueItems": true, - "minItems": 1 + "additionalProperties": false } }, - "additionalProperties": false + "additionalProperties": false, + "required": [ + "emoji_generator", + "emoji_index" + ] } }, - "additionalProperties": false, - "required": [ - "emoji_generator", - "emoji_index" - ] + "additionalProperties": false } - }, - "additionalProperties": false + ] }, { "oneOf": [ @@ -561,27 +572,38 @@ "additionalProperties": false }, { - "type": "object", - "properties": { - "pymdownx.tasklist": { + "oneOf": [ + { "title": "Tasklist – Python Markdown Extensions", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#tasklist", + "enum": [ + "pymdownx.tasklist" + ] + }, + { "type": "object", "properties": { - "custom_checkbox": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.tasklist.custom_checkbox", - "type": "boolean", - "default": true - }, - "clickable_checkbox": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.tasklist.clickable_checkbox", - "type": "boolean" + "pymdownx.tasklist": { + "title": "Tasklist – Python Markdown Extensions", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#tasklist", + "type": "object", + "properties": { + "custom_checkbox": { + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.tasklist.custom_checkbox", + "type": "boolean", + "default": true + }, + "clickable_checkbox": { + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.tasklist.clickable_checkbox", + "type": "boolean" + } + }, + "additionalProperties": false } }, "additionalProperties": false } - }, - "additionalProperties": false + ] }, { "oneOf": [ From d0d3c2a578abc318638f0c8331770459ca254c8f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Mazzucotelli?= Date: Sun, 11 Dec 2022 21:04:41 +0100 Subject: [PATCH 2/2] Add JSON schemas: mkdocs-coverage, mkdocs-spellcheck, markdown-exec --- docs/schema/plugins.json | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/schema/plugins.json b/docs/schema/plugins.json index ddddd8a39..2f287669b 100644 --- a/docs/schema/plugins.json +++ b/docs/schema/plugins.json @@ -88,6 +88,15 @@ }, { "$ref": "https://raw.githubusercontent.com/mkdocstrings/mkdocstrings/master/docs/schema.json" + }, + { + "$ref": "https://raw.githubusercontent.com/pawamoy/mkdocs-coverage/master/docs/schema.json" + }, + { + "$ref": "https://raw.githubusercontent.com/pawamoy/mkdocs-spellcheck/master/docs/schema.json" + }, + { + "$ref": "https://raw.githubusercontent.com/pawamoy/markdown-exec/master/docs/schema.json" } ] }