Skip to content

Commit 9d95854

Browse files
authored
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.
1 parent 8b94981 commit 9d95854

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

docs/schema/plugins.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,9 @@
6363
"external": {
6464
"description": "External plugins, schema provided by us",
6565
"anyOf": [
66+
{
67+
"$ref": "plugins/external/awesome-nav.json"
68+
},
6669
{
6770
"$ref": "plugins/external/gen-files.json"
6871
},
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
{
2+
"$schema": "http://json-schema.org/draft-07/schema",
3+
"title": "Custom advanced navigation config for MkDocs using extra YAML files.",
4+
"oneOf": [
5+
{
6+
"markdownDescription": "https://github.com/lukasgeiter/mkdocs-awesome-nav",
7+
"const": "awesome-nav"
8+
},
9+
{
10+
"type": "object",
11+
"properties": {
12+
"awesome-nav": {
13+
"type": "object",
14+
"markdownDescription": "https://lukasgeiter.github.io/mkdocs-awesome-nav",
15+
"properties": {
16+
"filename": {
17+
"title": "The YAML file that defines the navigation",
18+
"markdownDescription": "https://lukasgeiter.github.io/mkdocs-awesome-nav",
19+
"type": "string",
20+
"default": ".nav.yml"
21+
}
22+
},
23+
"additionalProperties": false
24+
}
25+
},
26+
"additionalProperties": false
27+
}
28+
]
29+
}

0 commit comments

Comments
 (0)