mkdocs-material/docs/schema/plugins/search.json
Alexander Voss 8622ea6381
Updated JSON schema (#6146)
* added missing "unrecognized_links"

* changed "definitions" to "$defs"

"$defs" is where people would expect definitions of
reusable subschemas to live
2023-10-06 09:53:01 +02:00

193 lines
4.7 KiB
JSON

{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Built-in search plugin",
"oneOf": [
{
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/",
"enum": [
"search"
]
},
{
"type": "object",
"properties": {
"search": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/",
"type": "object",
"properties": {
"lang": {
"oneOf": [
{
"$ref": "#/$defs/lang"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/lang"
},
"uniqueItems": true,
"minItems": 1
}
],
"default": "en"
},
"separator": {
"title": "Separator for indexing and query tokenization",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/#config.separator",
"type": "string"
},
"pipeline": {
"title": "Text processing pipeline for indexing",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/#config.pipeline",
"type": "array",
"items": {
"enum": [
"stemmer",
"stopWordFilter",
"trimmer"
]
},
"uniqueItems": true
},
"jieba_dict": {
"title": "Jieba dictionary replacement",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/#config.jieba_dict",
"type": "string"
},
"jieba_dict_user": {
"title": "Jieba dictionary augmentation",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/#config.jieba_dict_user",
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
],
"$defs": {
"lang": {
"title": "Site search language",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/#config.lang",
"oneOf": [
{
"title": "Site search language: Arabic",
"enum": [
"ar"
]
},
{
"title": "Site search language: Danish",
"enum": [
"da"
]
},
{
"title": "Site search language: German",
"enum": [
"de"
]
},
{
"title": "Site search language: Dutch",
"enum": [
"du"
]
},
{
"title": "Site search language: English",
"enum": [
"en"
]
},
{
"title": "Site search language: Spanish",
"enum": [
"es"
]
},
{
"title": "Site search language: Finnish",
"enum": [
"fi"
]
},
{
"title": "Site search language: French",
"enum": [
"fr"
]
},
{
"title": "Site search language: Hungarian",
"enum": [
"hu"
]
},
{
"title": "Site search language: Italian",
"enum": [
"it"
]
},
{
"title": "Site search language: Japanese",
"enum": [
"ja"
]
},
{
"title": "Site search language: Norwegian",
"enum": [
"no"
]
},
{
"title": "Site search language: Portuguese",
"enum": [
"pt"
]
},
{
"title": "Site search language: Romanian",
"enum": [
"ro"
]
},
{
"title": "Site search language: Russian",
"enum": [
"ru"
]
},
{
"title": "Site search language: Swedish",
"enum": [
"sv"
]
},
{
"title": "Site search language: Thai",
"enum": [
"th"
]
},
{
"title": "Site search language: Turkish",
"enum": [
"tr"
]
},
{
"title": "Site search language: Vietnamese",
"enum": [
"vi"
]
}
]
}
}
}