OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Updated JSON schema (#6146)

Browse Source 
* added missing "unrecognized_links"

* changed "definitions" to "$defs"

"$defs" is where people would expect definitions of
reusable subschemas to live
This commit is contained in:
Alexander Voss 2023-10-06 03:53:01 -04:00 committed by GitHub
parent 27a1e7c3ee
commit 8622ea6381
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 42 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/schema/extensions/markdown.json
View File

@ -73,10 +73,10 @@
"type": "object", "type": "object",
"properties": { "properties": {
"toc": { "toc": {
"$ref": "#/definitions/toc" "$ref": "#/$defs/toc"
}, },
"markdown.extensions.toc": { "markdown.extensions.toc": {
"$ref": "#/definitions/toc" "$ref": "#/$defs/toc"
} }
}, },
"additionalProperties": false "additionalProperties": false
@ -92,7 +92,7 @@
] ]
} }
], ],
"definitions": { "$defs": {
"toc": { "toc": {
"title": "Table Of Contents – Python Markdown", "title": "Table Of Contents – Python Markdown",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#table-of-contents", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#table-of-contents",

12
docs/schema/extra.json
View File

@ -68,7 +68,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"icon": { "icon": {
"$ref": "#/definitions/icon" "$ref": "#/$defs/icon"
}, },
"name": { "name": {
"title": "Feedback rating name", "title": "Feedback rating name",
@ -170,15 +170,15 @@
"type": "object", "type": "object",
"properties": { "properties": {
"analytics": { "analytics": {
"$ref": "#/definitions/cookie" "$ref": "#/$defs/cookie"
}, },
"github": { "github": {
"$ref": "#/definitions/cookie" "$ref": "#/$defs/cookie"
} }
}, },
"patternProperties": { "patternProperties": {
"\\w+": { "\\w+": {
"$ref": "#/definitions/cookie" "$ref": "#/$defs/cookie"
} }
}, },
"additionalProperties": false, "additionalProperties": false,
@ -261,7 +261,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"icon": { "icon": {
"$ref": "#/definitions/icon" "$ref": "#/$defs/icon"
}, },
"link": { "link": {
"title": "Social link", "title": "Social link",
@ -364,7 +364,7 @@
} }
}, },
"additionalProperties": true, "additionalProperties": true,
"definitions": { "$defs": {
"cookie": { "cookie": {
"title": "Cookie", "title": "Cookie",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent",

8
docs/schema/plugins.json
View File

@ -6,19 +6,19 @@
"items": { "items": {
"anyOf": [ "anyOf": [
{ {
"$ref": "#/definitions/built-in" "$ref": "#/$defs/built-in"
}, },
{ {
"$ref": "#/definitions/external" "$ref": "#/$defs/external"
}, },
{ {
"$ref": "#/definitions/external-community" "$ref": "#/$defs/external-community"
} }
] ]
}, },
"uniqueItems": true, "uniqueItems": true,
"minItems": 1, "minItems": 1,
"definitions": { "$defs": {
"built-in": { "built-in": {
"description": "Built-in plugins", "description": "Built-in plugins",
"anyOf": [ "anyOf": [

6
docs/schema/plugins/search.json
View File

@ -18,12 +18,12 @@
"lang": { "lang": {
"oneOf": [ "oneOf": [
{ {
"$ref": "#/definitions/lang" "$ref": "#/$defs/lang"
}, },
{ {
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/lang" "$ref": "#/$defs/lang"
}, },
"uniqueItems": true, "uniqueItems": true,
"minItems": 1 "minItems": 1
@ -66,7 +66,7 @@
"additionalProperties": false "additionalProperties": false
} }
], ],
"definitions": { "$defs": {
"lang": { "lang": {
"title": "Site search language", "title": "Site search language",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/#config.lang", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/#config.lang",

50
docs/schema/theme.json
View File

@ -455,16 +455,16 @@
"type": "object", "type": "object",
"properties": { "properties": {
"edit": { "edit": {
"$ref": "#/definitions/icon" "$ref": "#/$defs/icon"
}, },
"view": { "view": {
"$ref": "#/definitions/icon" "$ref": "#/$defs/icon"
}, },
"logo": { "logo": {
"$ref": "#/definitions/icon" "$ref": "#/$defs/icon"
}, },
"repo": { "repo": {
"$ref": "#/definitions/icon" "$ref": "#/$defs/icon"
}, },
"admonition": { "admonition": {
"title": "Admonition icon", "title": "Admonition icon",
@ -472,40 +472,40 @@
"type": "object", "type": "object",
"properties": { "properties": {
"note": { "note": {
"$ref": "#/definitions/icon" "$ref": "#/$defs/icon"
}, },
"abstract": { "abstract": {
"$ref": "#/definitions/icon" "$ref": "#/$defs/icon"
}, },
"info": { "info": {
"$ref": "#/definitions/icon" "$ref": "#/$defs/icon"
}, },
"tip": { "tip": {
"$ref": "#/definitions/icon" "$ref": "#/$defs/icon"
}, },
"success": { "success": {
"$ref": "#/definitions/icon" "$ref": "#/$defs/icon"
}, },
"question": { "question": {
"$ref": "#/definitions/icon" "$ref": "#/$defs/icon"
}, },
"warning": { "warning": {
"$ref": "#/definitions/icon" "$ref": "#/$defs/icon"
}, },
"failure": { "failure": {
"$ref": "#/definitions/icon" "$ref": "#/$defs/icon"
}, },
"danger": { "danger": {
"$ref": "#/definitions/icon" "$ref": "#/$defs/icon"
}, },
"bug": { "bug": {
"$ref": "#/definitions/icon" "$ref": "#/$defs/icon"
}, },
"example": { "example": {
"$ref": "#/definitions/icon" "$ref": "#/$defs/icon"
}, },
"quote": { "quote": {
"$ref": "#/definitions/icon" "$ref": "#/$defs/icon"
} }
}, },
"additionalProperties": false, "additionalProperties": false,
@ -566,7 +566,7 @@
"type": "object", "type": "object",
"patternProperties": { "patternProperties": {
"^[\\w-]+$": { "^[\\w-]+$": {
"$ref": "#/definitions/icon" "$ref": "#/$defs/icon"
} }
}, },
"additionalProperties": false "additionalProperties": false
@ -796,13 +796,13 @@
"type": "object", "type": "object",
"properties": { "properties": {
"scheme": { "scheme": {
"$ref": "#/definitions/scheme" "$ref": "#/$defs/scheme"
}, },
"primary": { "primary": {
"$ref": "#/definitions/primary" "$ref": "#/$defs/primary"
}, },
"accent": { "accent": {
"$ref": "#/definitions/accent" "$ref": "#/$defs/accent"
} }
}, },
"additionalProperties": false "additionalProperties": false
@ -815,13 +815,13 @@
"type": "object", "type": "object",
"properties": { "properties": {
"scheme": { "scheme": {
"$ref": "#/definitions/scheme" "$ref": "#/$defs/scheme"
}, },
"primary": { "primary": {
"$ref": "#/definitions/primary" "$ref": "#/$defs/primary"
}, },
"accent": { "accent": {
"$ref": "#/definitions/accent" "$ref": "#/$defs/accent"
}, },
"media": { "media": {
"oneOf": [ "oneOf": [
@ -850,7 +850,7 @@
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#color-palette-toggle", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#color-palette-toggle",
"properties": { "properties": {
"icon": { "icon": {
"$ref": "#/definitions/icon" "$ref": "#/$defs/icon"
}, },
"name": { "name": {
"title": "Color palette toggle name", "title": "Color palette toggle name",
@ -917,7 +917,7 @@
"required": [ "required": [
"name" "name"
], ],
"definitions": { "$defs": {
"scheme": { "scheme": {
"title": "Color scheme", "title": "Color scheme",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#color-scheme", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#color-scheme",

1
docs/schema/validation.json
View File

@ -7,6 +7,7 @@
"omitted_files": { "$ref": "#/$defs/omitted_files" }, "omitted_files": { "$ref": "#/$defs/omitted_files" },
"not_found": { "$ref": "#/$defs/not_found" }, "not_found": { "$ref": "#/$defs/not_found" },
"absolute_links": { "$ref": "#/$defs/absolute_links" }, "absolute_links": { "$ref": "#/$defs/absolute_links" },
"unrecognized_links": { "$ref": "#/$defs/unrecognized_links" },
"nav": { "nav": {
"title": "validation of navigation", "title": "validation of navigation",
"markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#validation", "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#validation",