starred/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2026-07-22 05:53:03 -04:00
Code Issues Packages Projects Releases Wiki Activity

Added JSON schema

Browse Source
This commit is contained in:
squidfunk
2022-01-29 16:12:25 +01:00
parent bcba266bfb
commit 8a1e52aa4a
7 changed files with 1476 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
docs/schema/plugins/minify.json Normal file
View File

@@ -0,0 +1,60 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Minify plugin",
"description": "Configuration syntax",
"type": "object",
"properties": {
"minify": {
"markdownDescription": "https://github.com/byrnereese/mkdocs-minify-plugin",
"type": "object",
"dependencies": {
"minify_js": [
"js_files"
],
"minify_css": [
"css_files"
]
},
"properties": {
"minify_html": {
"description": "Minify HTML files",
"type": "boolean"
},
"minify_js": {
"description": "Minify JS files",
"type": "boolean"
},
"minify_css": {
"description": "Minify CSS files",
"type": "boolean"
},
"htmlmin_opts": {
"description": "Options for HTML minifier",
"type": "object"
},
"js_files": {
"description": "List of JS files to minify",
"type": "array",
"items": {
"description": "JS file to minify",
"pattern": "\\.js$"
},
"uniqueItems": true,
"minItems": 1
},
"css_files": {
"description": "List of CSS files to minify",
"type": "array",
"items": {
"description": "CSS file to minify",
"pattern": "\\.css$"
},
"uniqueItems": true,
"minItems": 1
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}

37
docs/schema/plugins/redirects.json Normal file
View File

@@ -0,0 +1,37 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Redirects plugin",
"description": "Configuration syntax",
"type": "object",
"properties": {
"redirects": {
"markdownDescription": "https://github.com/datarobot/mkdocs-redirects",
"type": "object",
"properties": {
"redirect_maps": {
"description": "Internal and external redirects",
"type": "object",
"patternProperties": {
"\\.md$": {
"oneOf": [
{
"description": "Internal redirect",
"type": "string",
"pattern": "\\.md$"
},
{
"description": "External redirect",
"type": "string",
"pattern": "^https?:"
}
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}

165
docs/schema/plugins/search.json Normal file
View File

@@ -0,0 +1,165 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Built-in search plugin",
"description": "Configuration syntax",
"oneOf": [
{
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/",
"enum": [
"search"
]
},
{
"type": "object",
"properties": {
"search": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/",
"type": "object",
"properties": {
"lang": {
"oneOf": [
{ "$ref": "#/definitions/lang" },
{
"type": "array",
"items": {
"$ref": "#/definitions/lang"
},
"uniqueItems": true,
"minItems": 1
}
]
},
"separator": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#search-separator",
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
],
"definitions": {
"lang": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#search-lang",
"oneOf": [
{
"description": "Arabic",
"enum": [
"ar"
]
},
{
"description": "Danish",
"enum": [
"da"
]
},
{
"description": "German",
"enum": [
"de"
]
},
{
"description": "Dutch",
"enum": [
"du"
]
},
{
"description": "English",
"enum": [
"en"
]
},
{
"description": "Spanish",
"enum": [
"es"
]
},
{
"description": "Finnish",
"enum": [
"fi"
]
},
{
"description": "French",
"enum": [
"fr"
]
},
{
"description": "Hungarian",
"enum": [
"hu"
]
},
{
"description": "Italian",
"enum": [
"it"
]
},
{
"description": "Japanese",
"enum": [
"ja"
]
},
{
"description": "Norwegian",
"enum": [
"no"
]
},
{
"description": "Portuguese",
"enum": [
"pt"
]
},
{
"description": "Romanian",
"enum": [
"ro"
]
},
{
"description": "Russian",
"enum": [
"ru"
]
},
{
"description": "Swedish",
"enum": [
"sv"
]
},
{
"description": "Thai",
"enum": [
"th"
]
},
{
"description": "Turkish",
"enum": [
"tr"
]
},
{
"description": "Vietnamese",
"enum": [
"vi"
]
}
]
}
}
}