From 093b6e6aaa6bd2b32cceb525f3ab9bbc500dfd4d Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sun, 5 Jun 2022 10:26:58 +0200 Subject: [PATCH] Updated schema.json --- docs/schema.json | 16 +--- docs/schema/extensions/markdown.json | 8 +- docs/schema/extra.json | 113 +++++++++++++++++++-------- docs/schema/theme.json | 4 +- 4 files changed, 86 insertions(+), 55 deletions(-) diff --git a/docs/schema.json b/docs/schema.json index 2a244a1cc..e63acfdeb 100644 --- a/docs/schema.json +++ b/docs/schema.json @@ -143,19 +143,5 @@ "$ref": "schema/nav.json" } }, - "additionalProperties": false, - "defaultSnippets": [ - { - "label": "site_author", - "body": "${1:Jane Doe}" - }, - { - "label": "repo_url", - "body": "repo_url: https://github.com/${1:user}/${2:repo}" - }, - { - "label": "copyright", - "body": "copyright: Copyright © 2022 ${1:Jane Doe}" - } - ] + "additionalProperties": false } diff --git a/docs/schema/extensions/markdown.json b/docs/schema/extensions/markdown.json index 3153f8146..7c081fecd 100644 --- a/docs/schema/extensions/markdown.json +++ b/docs/schema/extensions/markdown.json @@ -142,13 +142,7 @@ ] } }, - "additionalProperties": false, - "defaultSnippets": [ - { - "label": "permalink", - "body": "permalink: true" - } - ] + "additionalProperties": false } } } diff --git a/docs/schema/extra.json b/docs/schema/extra.json index 3e86a98fc..118f26fd2 100644 --- a/docs/schema/extra.json +++ b/docs/schema/extra.json @@ -16,9 +16,10 @@ "properties": { "provider": { "title": "Analytics provider", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics", "oneOf": [ { + "title": "Google Analytics", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics", "enum": [ "google" ] @@ -108,7 +109,7 @@ ], "defaultSnippets": [ { - "label": "feedback", + "label": "feedback (default)", "body": { "feedback": { "title": "${1:Was this page helpful}", @@ -153,39 +154,19 @@ "type": "object", "properties": { "analytics": { - "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" - ] - }, - { - "type": "string" - } - ] + "$ref": "#/definitions/cookie" + } + }, + "patternProperties": { + "\\w+": { + "$ref": "#/definitions/cookie" } }, "additionalProperties": false, "defaultSnippets": [ { - "label": "analytics", + "label": "analytics (default)", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent", "body": { "analytics": { "name": "Google Analytics", @@ -194,9 +175,48 @@ } } ] + }, + "actions": { + "title": "Cookie consent actions", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent", + "type": "array", + "items": { + "oneOf": [ + { + "title": "Button to accept cookies", + "enum": [ + "accept" + ] + }, + { + "title": "Button to reject cookies", + "enum": [ + "reject" + ] + }, + { + "title": "Button to manage settings", + "enum": [ + "manage" + ] + } + ] + } } }, "additionalProperties": false, + "defaultSnippets": [ + { + "label": "actions (default)", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent", + "body": { + "actions": [ + "accept", + "manage" + ] + } + } + ], "required": [ "title", "description" @@ -304,6 +324,37 @@ }, "additionalProperties": true, "definitions": { + "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" + } + ] + }, "icon": { "oneOf": [ { @@ -318,7 +369,7 @@ }, "defaultSnippets": [ { - "label": "analytics", + "label": "analytics (default)", "body": { "analytics": { "provider": "${1:google}", diff --git a/docs/schema/theme.json b/docs/schema/theme.json index 48f68fc75..123190401 100644 --- a/docs/schema/theme.json +++ b/docs/schema/theme.json @@ -387,7 +387,7 @@ "pattern": "\\.(ico|png|svg|jpe?g)$", "defaultSnippets": [ { - "body": "${1}.png" + "body": "${1:path/to/file}.png" } ] }, @@ -397,7 +397,7 @@ "pattern": "\\.(png|svg|jpe?g)$", "defaultSnippets": [ { - "body": "${1}.png" + "body": "${1:path/to/file}.png" } ] },