Skip to content

Commit a0d8746

Browse files
committed
Updated JSON schema
1 parent e22c6b3 commit a0d8746

File tree

7 files changed

+44
-10
lines changed

7 files changed

+44
-10
lines changed

docs/schema/plugins.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@
2222
"built-in": {
2323
"description": "Built-in plugins",
2424
"oneOf": [
25+
{
26+
"$ref": "plugins/meta.json"
27+
},
2528
{
2629
"$ref": "plugins/offline.json"
2730
},

docs/schema/plugins/meta.json

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"$schema": "https://json-schema.org/draft-07/schema",
3+
"title": "Built-in meta plugin",
4+
"oneOf": [
5+
{
6+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/#built-in-meta-plugin",
7+
"enum": [
8+
"meta"
9+
]
10+
},
11+
{
12+
"type": "object",
13+
"properties": {
14+
"meta": {
15+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/#built-in-meta-plugin",
16+
"type": "object",
17+
"properties": {
18+
"meta_file": {
19+
"title": "Meta file name",
20+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/#meta-file",
21+
"pattern": "\\.yml$",
22+
"default": "\"**/.meta.yml\""
23+
}
24+
},
25+
"additionalProperties": false
26+
}
27+
},
28+
"additionalProperties": false
29+
}
30+
]
31+
}

docs/schema/plugins/offline.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"title": "Built-in offline plugin",
44
"oneOf": [
55
{
6-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-for-offline-usage/",
6+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-for-offline-usage/#built-in-offline-plugin",
77
"enum": [
88
"offline"
99
]
@@ -12,7 +12,7 @@
1212
"type": "object",
1313
"properties": {
1414
"offline": {
15-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-for-offline-usage/",
15+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-for-offline-usage/#built-in-offline-plugin",
1616
"type": "object",
1717
"properties": {
1818
"enabled": {

docs/schema/plugins/privacy.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"title": "Built-in privacy plugin",
44
"oneOf": [
55
{
6-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/",
6+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#built-in-privacy-plugin",
77
"enum": [
88
"privacy"
99
]
@@ -12,7 +12,7 @@
1212
"type": "object",
1313
"properties": {
1414
"privacy": {
15-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/",
15+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#built-in-privacy-plugin",
1616
"type": "object",
1717
"properties": {
1818
"enabled": {

docs/schema/plugins/search.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"title": "Built-in search plugin",
44
"oneOf": [
55
{
6-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/",
6+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#built-in-search-plugin",
77
"enum": [
88
"search"
99
]
@@ -12,7 +12,7 @@
1212
"type": "object",
1313
"properties": {
1414
"search": {
15-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/",
15+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#built-in-search-plugin",
1616
"type": "object",
1717
"properties": {
1818
"lang": {

docs/schema/plugins/social.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"title": "Built-in social plugin",
44
"oneOf": [
55
{
6-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/",
6+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#built-in-social-plugin",
77
"enum": [
88
"social"
99
]
@@ -12,7 +12,7 @@
1212
"type": "object",
1313
"properties": {
1414
"social": {
15-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/",
15+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#built-in-social-plugin",
1616
"type": "object",
1717
"properties": {
1818
"cards": {

docs/schema/plugins/tags.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"title": "Built-in tags plugin",
44
"oneOf": [
55
{
6-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/",
6+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#built-in-tags-plugin",
77
"enum": [
88
"tags"
99
]
@@ -12,7 +12,7 @@
1212
"type": "object",
1313
"properties": {
1414
"tags": {
15-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/",
15+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#built-in-tags-plugin",
1616
"type": "object",
1717
"properties": {
1818
"tags_file": {

0 commit comments

Comments
 (0)