mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-06-14 11:52:32 +03:00
Merge pull request #6361 from sisp/fix/analytics-schema
Fixed `extra:analytics` schema for custom providers
This commit is contained in:
Martin Donath
GitHub
commit
1cc4aca43a
@ -13,99 +13,75 @@
|
||||
"title": "Analytics provider",
|
||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"provider": {
|
||||
"title": "Analytics provider",
|
||||
"anyOf": [
|
||||
{
|
||||
"title": "Google Analytics",
|
||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics",
|
||||
"enum": [
|
||||
"google"
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
"property": {
|
||||
"anyOf": [
|
||||
{
|
||||
"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": "#/$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"
|
||||
"allOf": [
|
||||
{
|
||||
"if": {
|
||||
"properties": {
|
||||
"provider": {
|
||||
"enum": [
|
||||
"google"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"title"
|
||||
]
|
||||
"then": {
|
||||
"properties": {
|
||||
"provider": {
|
||||
"title": "Google Analytics",
|
||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics",
|
||||
"enum": [
|
||||
"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}$"
|
||||
},
|
||||
{
|
||||
"title": "Unknown property",
|
||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics",
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
"feedback": {
|
||||
"$ref": "#/$defs/feedback"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"provider",
|
||||
"property"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
},
|
||||
{
|
||||
"if": {
|
||||
"properties": {
|
||||
"provider": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"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"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"provider",
|
||||
"property"
|
||||
],
|
||||
"defaultSnippets": [
|
||||
{
|
||||
@ -406,6 +382,59 @@
|
||||
"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"
|
||||
]
|
||||
}
|
||||
},
|
||||
"defaultSnippets": [
|
||||
@ -414,7 +443,7 @@
|
||||
"body": {
|
||||
"analytics": {
|
||||
"provider": "${1:google}",
|
||||
"property": "${2:UA-XXXXXXXX-X}"
|
||||
"property": "${2:G-XXXXXXXXXX}"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user