1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-12-29 15:53:10 +01:00
mkdocs-material/docs/schema/extra.json

446 lines
15 KiB
JSON
Raw Normal View History

2022-01-29 19:14:23 +01:00
{
"$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",
"allOf": [
{
"if": {
"properties": {
"provider": {
"const": "google"
}
2022-01-29 19:14:23 +01:00
}
},
"then": {
"properties": {
"provider": {
"title": "Google Analytics",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics",
"const": "google"
},
"property": {
"anyOf": [
{
"title": "Google Analytics 4",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics",
"pattern": "^G-\\w{10}$"
2022-01-29 19:14:23 +01:00
},
{
"title": "Unknown property",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics",
2022-01-29 19:14:23 +01:00
"type": "string"
}
]
},
"feedback": {
"$ref": "#/$defs/feedback"
}
},
"required": [
"provider",
"property"
],
"additionalProperties": false
}
},
{
"if": {
"properties": {
"provider": {
"type": "string"
2022-01-29 19:14:23 +01:00
}
}
},
"then": {
"properties": {
"provider": {
"title": "Custom analytics provider",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#custom-site-analytics",
"type": "string"
},
"feedback": {
"$ref": "#/$defs/feedback"
}
},
"required": [
"provider"
]
}
2022-01-29 19:14:23 +01:00
}
2022-01-30 14:19:35 +01:00
],
"defaultSnippets": [
{
2022-06-05 10:26:58 +02:00
"label": "feedback (default)",
2022-01-30 14:19:35 +01:00
"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!}"
}
]
}
}
}
2022-01-29 19:14:23 +01:00
]
},
2023-07-07 11:22:30 +02:00
"annotate": {
"title": "Custom selectors for annotations",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#custom-selectors",
"type": "object",
"patternProperties": {
".*": {
"title": "Custom selector",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#custom-selectors",
"type": "array",
"items": {
"type": "string",
"pattern": "^\\.\\w+"
}
}
}
},
2022-01-29 19:14:23 +01:00
"consent": {
"title": "Cookie consent",
2022-03-23 11:08:22 +01:00
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent",
2022-01-29 19:14:23 +01:00
"type": "object",
"properties": {
"title": {
"title": "Cookie consent title",
2022-09-11 19:25:40 +02:00
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.title",
2022-01-29 19:14:23 +01:00
"type": "string",
"default": "Cookie consent"
},
"description": {
"title": "Cookie consent description",
2022-09-11 19:25:40 +02:00
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.description",
2022-01-29 19:14:23 +01:00
"type": "string"
},
"cookies": {
"title": "Cookies",
2022-09-11 19:25:40 +02:00
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.cookies",
2022-01-29 19:14:23 +01:00
"type": "object",
"properties": {
"analytics": {
"$ref": "#/$defs/cookie"
2022-09-18 15:40:38 +02:00
},
"github": {
"$ref": "#/$defs/cookie"
2022-06-05 10:26:58 +02:00
}
},
"patternProperties": {
"\\w+": {
"$ref": "#/$defs/cookie"
2022-01-29 19:14:23 +01:00
}
},
2022-01-30 14:19:35 +01:00
"additionalProperties": false,
"defaultSnippets": [
{
2022-06-05 10:26:58 +02:00
"label": "analytics (default)",
2022-09-11 19:25:40 +02:00
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.cookies",
2022-01-30 14:19:35 +01:00
"body": {
"analytics": {
"name": "Google Analytics",
"checked": true
}
}
2022-09-18 15:40:38 +02:00
},
{
"label": "github (default)",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.cookies",
"body": {
"analytics": {
"name": "GitHub",
"checked": true
}
}
2022-01-30 14:19:35 +01:00
}
]
2022-06-05 10:26:58 +02:00
},
"actions": {
"title": "Cookie consent actions",
2022-09-11 19:25:40 +02:00
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.actions",
2022-06-05 10:26:58 +02:00
"type": "array",
"items": {
"oneOf": [
{
"title": "Button to accept cookies",
"const": "accept"
2022-06-05 10:26:58 +02:00
},
{
"title": "Button to reject cookies",
"const": "reject"
2022-06-05 10:26:58 +02:00
},
{
"title": "Button to manage settings",
"const": "manage"
2022-06-05 10:26:58 +02:00
}
]
2022-12-11 15:53:16 +01:00
},
"uniqueItems": true
2022-01-29 19:14:23 +01:00
}
},
"additionalProperties": false,
2022-06-05 10:26:58 +02:00
"defaultSnippets": [
{
"label": "actions (default)",
2022-09-11 19:25:40 +02:00
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.actions",
2022-06-05 10:26:58 +02:00
"body": {
"actions": [
"accept",
"manage"
]
}
}
],
2022-01-29 19:14:23 +01:00
"required": [
"title",
"description"
]
},
"social": {
"title": "Social links",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#social-links",
"type": "array",
"items": {
2022-01-29 20:50:47 +01:00
"title": "Social link",
2022-01-29 19:14:23 +01:00
"type": "object",
"properties": {
"icon": {
"$ref": "#/$defs/icon"
2022-01-29 19:14:23 +01:00
},
"link": {
"title": "Social link",
2022-09-11 19:25:40 +02:00
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#+social.link",
2022-01-29 19:14:23 +01:00
"type": "string"
},
"name": {
"title": "Social link name",
2022-09-11 19:25:40 +02:00
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#+social.name",
2022-01-29 19:14:23 +01:00
"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",
2022-09-11 19:25:40 +02:00
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#+alternate.name",
2022-01-29 19:14:23 +01:00
"type": "string"
},
"link": {
"title": "Alternate language link",
2022-09-11 19:25:40 +02:00
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#+alternate.link",
2022-01-29 19:14:23 +01:00
"type": "string"
},
"lang": {
"title": "Alternate language code (ISO 639-1)",
2022-09-11 19:25:40 +02:00
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#+alternate.lang",
2022-01-29 19:14:23 +01:00
"type": "string"
}
},
"additionalProperties": false,
"required": [
"name",
"link",
"lang"
]
}
},
2022-04-24 23:22:03 +02:00
"tags": {
"title": "Tag identifiers",
2022-10-22 08:43:36 +02:00
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#tag-icons-and-identifiers",
2022-04-24 23:22:03 +02:00
"type": "object",
"patternProperties": {
".*": {
"title": "Tag identifier mapping",
2022-10-22 08:43:36 +02:00
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#tag-icons-and-identifiers",
2022-04-24 23:22:03 +02:00
"pattern": "^[\\w-]+$"
}
}
},
2022-01-29 19:14:23 +01:00
"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",
"const": "mike"
2022-01-29 19:14:23 +01:00
},
"default": {
"title": "Default version",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/#version-warning",
2023-02-18 13:29:59 +01:00
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
2022-01-29 19:14:23 +01:00
"default": "stable"
},
"alias": {
"title": "Show alias next to version number",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-versioning/#version-alias",
"type": "boolean",
"default": true
2022-01-29 19:14:23 +01:00
}
}
},
"generator": {
"title": "Generator notice",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#generator-notice",
"type": "boolean",
"default": true
}
},
2022-01-30 18:00:23 +01:00
"additionalProperties": true,
"$defs": {
2022-06-05 10:26:58 +02:00
"cookie": {
"title": "Cookie",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent",
"oneOf": [
{
"type": "object",
"properties": {
"name": {
"title": "Cookie name",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent",
"type": "string"
},
"checked": {
"title": "Initial state",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent",
"type": "boolean",
"default": true
}
},
"additionalProperties": false,
"required": [
"name"
]
},
{
"title": "Cookie name",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent",
"type": "string"
}
]
},
2022-01-30 14:19:35 +01:00
"icon": {
2023-01-14 20:48:22 +01:00
"anyOf": [
2022-01-30 14:19:35 +01:00
{
"$ref": "assets/icons.json"
},
{
2022-01-30 18:00:23 +01:00
"title": "Unknown icon",
2022-01-30 14:19:35 +01:00
"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": "#/$defs/icon"
},
"name": {
"title": "Feedback rating name",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#+analytics.feedback.ratings.name",
"type": "string"
},
"data": {
"title": "Feedback rating data",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#+analytics.feedback.ratings.data",
"type": "number"
},
"note": {
"title": "Feedback rating data",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#+analytics.feedback.ratings.note",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"icon",
"name",
"data",
"note"
]
}
}
},
"additionalProperties": false,
"required": [
"title"
]
2022-01-30 14:19:35 +01:00
}
},
"defaultSnippets": [
{
2022-06-05 10:26:58 +02:00
"label": "analytics (default)",
2022-01-30 14:19:35 +01:00
"body": {
"analytics": {
"provider": "${1:google}",
"property": "${2:G-XXXXXXXXXX}"
2022-01-30 14:19:35 +01:00
}
}
}
]
2022-01-29 19:14:23 +01:00
}