From 9d958543d01ccedd0b6531f8129cfb76ef3d812a Mon Sep 17 00:00:00 2001 From: "B. Batkhuu" Date: Tue, 29 Jul 2025 18:29:54 +0900 Subject: [PATCH] Added JSON schema for `mkdocs-awesome-nav` plugin (#8341) * Add JSON schema for external plugin - "mkdocs-awesome-nav". * Add reference to 'awesome-nav' plugin in external plugins schema. * art: Fix missing newline at end of file in plugins schema files. --- docs/schema/plugins.json | 3 ++ docs/schema/plugins/external/awesome-nav.json | 29 +++++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 docs/schema/plugins/external/awesome-nav.json diff --git a/docs/schema/plugins.json b/docs/schema/plugins.json index 5c436205b..4d019eb05 100644 --- a/docs/schema/plugins.json +++ b/docs/schema/plugins.json @@ -63,6 +63,9 @@ "external": { "description": "External plugins, schema provided by us", "anyOf": [ + { + "$ref": "plugins/external/awesome-nav.json" + }, { "$ref": "plugins/external/gen-files.json" }, diff --git a/docs/schema/plugins/external/awesome-nav.json b/docs/schema/plugins/external/awesome-nav.json new file mode 100644 index 000000000..20be4764e --- /dev/null +++ b/docs/schema/plugins/external/awesome-nav.json @@ -0,0 +1,29 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Custom advanced navigation config for MkDocs using extra YAML files.", + "oneOf": [ + { + "markdownDescription": "https://github.com/lukasgeiter/mkdocs-awesome-nav", + "const": "awesome-nav" + }, + { + "type": "object", + "properties": { + "awesome-nav": { + "type": "object", + "markdownDescription": "https://lukasgeiter.github.io/mkdocs-awesome-nav", + "properties": { + "filename": { + "title": "The YAML file that defines the navigation", + "markdownDescription": "https://lukasgeiter.github.io/mkdocs-awesome-nav", + "type": "string", + "default": ".nav.yml" + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false + } + ] +}