From 65501ffc934f63a507c511f36c9ceee564e61513 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sat, 17 Dec 2022 23:00:06 +0100 Subject: [PATCH] Added default variants for plugins to schema --- .../schema/plugins/external/literate-nav.json | 44 ++++--- docs/schema/plugins/external/macros.json | 114 ++++++++++-------- 2 files changed, 89 insertions(+), 69 deletions(-) diff --git a/docs/schema/plugins/external/literate-nav.json b/docs/schema/plugins/external/literate-nav.json index 53fd6970d..3a2f518e4 100644 --- a/docs/schema/plugins/external/literate-nav.json +++ b/docs/schema/plugins/external/literate-nav.json @@ -1,27 +1,37 @@ { "$schema": "http://json-schema.org/draft-07/schema", - "title": "Literate nav plugin", - "type": "object", - "properties": { - "literate-nav": { + "title": "Literate navigation plugin", + "oneOf": [ + { "markdownDescription": "https://github.com/oprypin/mkdocs-literate-nav", + "enum": [ + "literate-nav" + ] + }, + { "type": "object", "properties": { - "nav_file": { - "title": "The name of the file to read to determine the navigation for a particular directory under `docs_dir`", - "markdownDescription": "https://oprypin.github.io/mkdocs-literate-nav/reference.html#nav_file", - "type": "string", - "default": "SUMMARY.md" - }, - "implicit_index": { - "title": "If set and a directory has a file named `index.md` or `README.md`, but the literate nav for that directory that never includes it, it will be inserted as the first item of the nav", - "markdownDescription": "https://oprypin.github.io/mkdocs-literate-nav/reference.html#implicit_index", - "type": "boolean", - "default": false + "literate-nav": { + "markdownDescription": "https://github.com/oprypin/mkdocs-literate-nav", + "type": "object", + "properties": { + "nav_file": { + "title": "The name of the file to read to determine the navigation for a particular directory under `docs_dir`", + "markdownDescription": "https://oprypin.github.io/mkdocs-literate-nav/reference.html#nav_file", + "type": "string", + "default": "SUMMARY.md" + }, + "implicit_index": { + "title": "If set and a directory has a file named `index.md` or `README.md`, but the literate nav for that directory that never includes it, it will be inserted as the first item of the nav", + "markdownDescription": "https://oprypin.github.io/mkdocs-literate-nav/reference.html#implicit_index", + "type": "boolean", + "default": false + } + }, + "additionalProperties": false } }, "additionalProperties": false } - }, - "additionalProperties": false + ] } diff --git a/docs/schema/plugins/external/macros.json b/docs/schema/plugins/external/macros.json index 80a1f4e74..450118c62 100644 --- a/docs/schema/plugins/external/macros.json +++ b/docs/schema/plugins/external/macros.json @@ -1,62 +1,72 @@ { "$schema": "http://json-schema.org/draft-07/schema", "title": "Macros plugin", - "type": "object", - "properties": { - "macros": { - "markdownDescription": "", + "oneOf": [ + { + "markdownDescription": "https://github.com/oprypin/mkdocs-literate-nav", + "enum": [ + "literate-nav" + ] + }, + { "type": "object", "properties": { - "module_name": { - "title": "Name of the Python module containing macros, filters and variables.", - "markdownDescription": "https://mkdocs-macros-plugin.readthedocs.io/en/latest/#configuration-of-the-plugin", - "type": "string", - "default": "main" - }, - "modules": { - "title": "List of preinstalled Python modules, i.e. listed by `pip list`.", - "markdownDescription": "https://mkdocs-macros-plugin.readthedocs.io/en/latest/#configuration-of-the-plugin", - "type": "array" - }, - "include_dir": { - "title": "Directory for including external files", - "markdownDescription": "https://mkdocs-macros-plugin.readthedocs.io/en/latest/advanced/#changing-the-directory-of-the-includes", - "type": "string" - }, - "include_yaml": { - "title": "List of yaml files or `key: filename` pairs to be included", - "markdownDescription": "https://mkdocs-macros-plugin.readthedocs.io/en/latest/advanced/#including-external-yaml-files", - "type": "array" - }, - "j2_block_start_string": { - "title": "Non-standard Jinja2 marker for start of block", - "markdownDescription": "https://mkdocs-macros-plugin.readthedocs.io/en/latest/advanced/#solution-4-altering-the-syntax-of-jinja2-for-mkdocs-macros", - "type": "string" - }, - "j2_block_end_string": { - "title": "Non-standard Jinja2 marker for end of block", - "markdownDescription": "https://mkdocs-macros-plugin.readthedocs.io/en/latest/advanced/#solution-4-altering-the-syntax-of-jinja2-for-mkdocs-macros", - "type": "string" - }, - "j2_variable_start_string": { - "title": "Non-standard Jinja2 marker for start of variable", - "markdownDescription": "https://mkdocs-macros-plugin.readthedocs.io/en/latest/advanced/#solution-4-altering-the-syntax-of-jinja2-for-mkdocs-macros", - "type": "string" - }, - "j2_variable_end_string": { - "title": "Non-standard Jinja2 marker for end of variable", - "markdownDescription": "https://mkdocs-macros-plugin.readthedocs.io/en/latest/advanced/#solution-4-altering-the-syntax-of-jinja2-for-mkdocs-macros", - "type": "string" - }, - "on_error_fail": { - "title": "Stop build/serve when macro error happens", - "markdownDescription": "https://mkdocs-macros-plugin.readthedocs.io/en/latest/advanced/#can-i-make-mkdocs-macros-build-process-to-fail-in-case-of-error-instead-of-displaying-the-error-on-the-page", - "type": "boolean", - "default": false + "macros": { + "markdownDescription": "", + "type": "object", + "properties": { + "module_name": { + "title": "Name of the Python module containing macros, filters and variables", + "markdownDescription": "https://mkdocs-macros-plugin.readthedocs.io/en/latest/#configuration-of-the-plugin", + "type": "string", + "default": "main" + }, + "modules": { + "title": "List of preinstalled Python modules, i.e. listed by `pip list`", + "markdownDescription": "https://mkdocs-macros-plugin.readthedocs.io/en/latest/#configuration-of-the-plugin", + "type": "array" + }, + "include_dir": { + "title": "Directory for including external files", + "markdownDescription": "https://mkdocs-macros-plugin.readthedocs.io/en/latest/advanced/#changing-the-directory-of-the-includes", + "type": "string" + }, + "include_yaml": { + "title": "List of yaml files or `key: filename` pairs to be included", + "markdownDescription": "https://mkdocs-macros-plugin.readthedocs.io/en/latest/advanced/#including-external-yaml-files", + "type": "array" + }, + "j2_block_start_string": { + "title": "Non-standard Jinja2 marker for start of block", + "markdownDescription": "https://mkdocs-macros-plugin.readthedocs.io/en/latest/advanced/#solution-4-altering-the-syntax-of-jinja2-for-mkdocs-macros", + "type": "string" + }, + "j2_block_end_string": { + "title": "Non-standard Jinja2 marker for end of block", + "markdownDescription": "https://mkdocs-macros-plugin.readthedocs.io/en/latest/advanced/#solution-4-altering-the-syntax-of-jinja2-for-mkdocs-macros", + "type": "string" + }, + "j2_variable_start_string": { + "title": "Non-standard Jinja2 marker for start of variable", + "markdownDescription": "https://mkdocs-macros-plugin.readthedocs.io/en/latest/advanced/#solution-4-altering-the-syntax-of-jinja2-for-mkdocs-macros", + "type": "string" + }, + "j2_variable_end_string": { + "title": "Non-standard Jinja2 marker for end of variable", + "markdownDescription": "https://mkdocs-macros-plugin.readthedocs.io/en/latest/advanced/#solution-4-altering-the-syntax-of-jinja2-for-mkdocs-macros", + "type": "string" + }, + "on_error_fail": { + "title": "Stop build/serve when macro error happens", + "markdownDescription": "https://mkdocs-macros-plugin.readthedocs.io/en/latest/advanced/#can-i-make-mkdocs-macros-build-process-to-fail-in-case-of-error-instead-of-displaying-the-error-on-the-page", + "type": "boolean", + "default": false + } + }, + "additionalProperties": false } }, "additionalProperties": false } - }, - "additionalProperties": false + ] }