mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-12-18 10:25:58 +01:00
319 lines
11 KiB
JSON
319 lines
11 KiB
JSON
{
|
|
"$schema": "https://json-schema.org/draft-07/schema",
|
|
"title": "Extra configuration",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/",
|
|
"type": "object",
|
|
"properties": {
|
|
"homepage": {
|
|
"title": "Homepage link (when clicking on logo)",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/#logo",
|
|
"type": "string"
|
|
},
|
|
"analytics": {
|
|
"title": "Analytics provider",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics",
|
|
"type": "object",
|
|
"properties": {
|
|
"provider": {
|
|
"title": "Analytics provider",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics",
|
|
"oneOf": [
|
|
{
|
|
"enum": [
|
|
"google"
|
|
]
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"property": {
|
|
"oneOf": [
|
|
{
|
|
"title": "Google Analytics 4",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics",
|
|
"pattern": "^G-\\w{10}$"
|
|
},
|
|
{
|
|
"title": "Universal Analytics",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics",
|
|
"pattern": "^UA-\\w{9}-\\w$"
|
|
},
|
|
{
|
|
"title": "Unknown property",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics",
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"feedback": {
|
|
"title": "Was this page helpful?",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#was-this-page-helpful",
|
|
"type": "object",
|
|
"properties": {
|
|
"title": {
|
|
"title": "Feedback widget title",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#was-this-page-helpful",
|
|
"type": "string",
|
|
"default": "Was this page helpful?"
|
|
},
|
|
"ratings": {
|
|
"title": "Feedback ratings",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#was-this-page-helpful",
|
|
"type": "array",
|
|
"items": {
|
|
"title": "Feedback rating",
|
|
"type": "object",
|
|
"properties": {
|
|
"icon": {
|
|
"$ref": "#/definitions/icon"
|
|
},
|
|
"name": {
|
|
"title": "Feedback rating name",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#feedback-rating-name",
|
|
"type": "string"
|
|
},
|
|
"data": {
|
|
"title": "Feedback rating data",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#feedback-rating-data",
|
|
"type": "number"
|
|
},
|
|
"note": {
|
|
"title": "Feedback rating data",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#feedback-rating-note",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"icon",
|
|
"name",
|
|
"data",
|
|
"note"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"provider",
|
|
"property"
|
|
],
|
|
"defaultSnippets": [
|
|
{
|
|
"label": "feedback",
|
|
"body": {
|
|
"feedback": {
|
|
"title": "${1:Was this page helpful}",
|
|
"ratings": [
|
|
{
|
|
"icon": "${2:material/emoticon-happy-outline}",
|
|
"name": "${3:This page was helpful}",
|
|
"data": 1,
|
|
"note": "${4:Thanks for your feedback!}"
|
|
},
|
|
{
|
|
"icon": "${5:material/emoticon-sad-outline}",
|
|
"name": "${6:This page could be improved}",
|
|
"data": 0,
|
|
"note": "${7:Thanks for your feedback!}"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"consent": {
|
|
"title": "Cookie consent",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#cookie-consent",
|
|
"type": "object",
|
|
"properties": {
|
|
"title": {
|
|
"title": "Cookie consent title",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#cookie-consent",
|
|
"type": "string",
|
|
"default": "Cookie consent"
|
|
},
|
|
"description": {
|
|
"title": "Cookie consent description",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#cookie-consent",
|
|
"type": "string"
|
|
},
|
|
"cookies": {
|
|
"title": "Cookies",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#cookie-consent",
|
|
"type": "object",
|
|
"properties": {
|
|
"analytics": {
|
|
"title": "Cookie",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#cookie-consent",
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"title": "Cookie name",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#cookie-consent",
|
|
"type": "string"
|
|
},
|
|
"checked": {
|
|
"title": "Initial state",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#cookie-consent",
|
|
"type": "boolean",
|
|
"default": true
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"name"
|
|
]
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"defaultSnippets": [
|
|
{
|
|
"label": "analytics",
|
|
"body": {
|
|
"analytics": {
|
|
"name": "Google Analytics",
|
|
"checked": true
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"title",
|
|
"description"
|
|
]
|
|
},
|
|
"social": {
|
|
"title": "Social links",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#social-links",
|
|
"type": "array",
|
|
"items": {
|
|
"title": "Social link",
|
|
"type": "object",
|
|
"properties": {
|
|
"icon": {
|
|
"$ref": "#/definitions/icon"
|
|
},
|
|
"link": {
|
|
"title": "Social link",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#social-link",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"title": "Social link name",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#social-name",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"icon",
|
|
"link"
|
|
]
|
|
}
|
|
},
|
|
"alternate": {
|
|
"title": "Site language selector",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language-selector",
|
|
"type": "array",
|
|
"items": {
|
|
"title": "Alternate language",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language-selector",
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"title": "Alternate language name",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#language-name",
|
|
"type": "string"
|
|
},
|
|
"link": {
|
|
"title": "Alternate language link",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#language-link",
|
|
"type": "string"
|
|
},
|
|
"lang": {
|
|
"title": "Alternate language code (ISO 639-1)",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#language-lang",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"name",
|
|
"link",
|
|
"lang"
|
|
]
|
|
}
|
|
},
|
|
"version": {
|
|
"title": "Versioning",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/#versioning",
|
|
"type": "object",
|
|
"properties": {
|
|
"provider": {
|
|
"title": "Versioning provider",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/#versioning",
|
|
"enum": [
|
|
"mike"
|
|
]
|
|
},
|
|
"default": {
|
|
"title": "Default version",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/#version-warning",
|
|
"default": "stable"
|
|
}
|
|
}
|
|
},
|
|
"generator": {
|
|
"title": "Generator notice",
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#generator-notice",
|
|
"type": "boolean",
|
|
"default": true
|
|
}
|
|
},
|
|
"additionalProperties": true,
|
|
"definitions": {
|
|
"icon": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "assets/icons.json"
|
|
},
|
|
{
|
|
"title": "Unknown icon",
|
|
"type": "string"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultSnippets": [
|
|
{
|
|
"label": "analytics",
|
|
"body": {
|
|
"analytics": {
|
|
"provider": "${1:google}",
|
|
"property": "${2:UA-XXXXXXXX-X}"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|