From f08566ada1b40ab35c9ea40da0e6f73aa1071a1f Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sat, 28 Jan 2023 14:41:31 +0100 Subject: [PATCH] Updated JSON schema --- docs/schema/plugins/external/gen-files.json | 5 +++-- docs/schema/plugins/external/git-authors.json | 2 +- docs/schema/plugins/external/git-committers.json | 2 +- docs/schema/plugins/external/git-revision-date.json | 2 +- docs/schema/plugins/external/literate-nav.json | 2 +- docs/schema/plugins/external/macros.json | 2 +- docs/schema/plugins/external/minify.json | 2 +- docs/schema/plugins/external/redirects.json | 10 +++++----- docs/schema/plugins/external/section-index.json | 8 ++++---- 9 files changed, 18 insertions(+), 17 deletions(-) diff --git a/docs/schema/plugins/external/gen-files.json b/docs/schema/plugins/external/gen-files.json index 92b2ce061..f1ee3d4ab 100644 --- a/docs/schema/plugins/external/gen-files.json +++ b/docs/schema/plugins/external/gen-files.json @@ -1,6 +1,6 @@ { "$schema": "https://json-schema.org/draft-07/schema", - "title": "MkDocs plugin to programmatically generate documentation pages during the build", + "title": "Generate pages during the build", "oneOf": [ { "markdownDescription": "https://github.com/oprypin/mkdocs-gen-files", @@ -24,5 +24,6 @@ "type": ["object", "null"] } } - }] + } + ] } diff --git a/docs/schema/plugins/external/git-authors.json b/docs/schema/plugins/external/git-authors.json index a76f3b9e0..5ac5653d7 100644 --- a/docs/schema/plugins/external/git-authors.json +++ b/docs/schema/plugins/external/git-authors.json @@ -1,6 +1,6 @@ { "$schema": "https://json-schema.org/draft-07/schema", - "title": "Git authors plugin", + "title": "Add git authors to pages", "oneOf": [ { "markdownDescription": "https://timvink.github.io/mkdocs-git-authors-plugin/", diff --git a/docs/schema/plugins/external/git-committers.json b/docs/schema/plugins/external/git-committers.json index 43e371eb2..292fc9e8e 100644 --- a/docs/schema/plugins/external/git-committers.json +++ b/docs/schema/plugins/external/git-committers.json @@ -1,6 +1,6 @@ { "$schema": "https://json-schema.org/draft-07/schema", - "title": "Git committers plugin", + "title": "Add git contributors to pages", "oneOf": [ { "markdownDescription": "https://github.com/ojacques/mkdocs-git-committers-plugin-2", diff --git a/docs/schema/plugins/external/git-revision-date.json b/docs/schema/plugins/external/git-revision-date.json index 97d9dbaa6..71c5a0213 100644 --- a/docs/schema/plugins/external/git-revision-date.json +++ b/docs/schema/plugins/external/git-revision-date.json @@ -1,6 +1,6 @@ { "$schema": "https://json-schema.org/draft-07/schema", - "title": "Git revision date plugin", + "title": "Add git revision date to pages", "oneOf": [ { "markdownDescription": "https://github.com/zhaoterryy/mkdocs-git-revision-date-plugin", diff --git a/docs/schema/plugins/external/literate-nav.json b/docs/schema/plugins/external/literate-nav.json index 3a2f518e4..2cac166a8 100644 --- a/docs/schema/plugins/external/literate-nav.json +++ b/docs/schema/plugins/external/literate-nav.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/draft-07/schema", - "title": "Literate navigation plugin", + "title": "Configure navigation in Markdown instead of YAML", "oneOf": [ { "markdownDescription": "https://github.com/oprypin/mkdocs-literate-nav", diff --git a/docs/schema/plugins/external/macros.json b/docs/schema/plugins/external/macros.json index cd2d69f2d..56a3c2958 100644 --- a/docs/schema/plugins/external/macros.json +++ b/docs/schema/plugins/external/macros.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/draft-07/schema", - "title": "Macros plugin", + "title": "Use variables and macros in Markdown", "oneOf": [ { "markdownDescription": "https://github.com/fralau/mkdocs_macros_plugin", diff --git a/docs/schema/plugins/external/minify.json b/docs/schema/plugins/external/minify.json index 22b3e242a..5867fa653 100644 --- a/docs/schema/plugins/external/minify.json +++ b/docs/schema/plugins/external/minify.json @@ -1,6 +1,6 @@ { "$schema": "https://json-schema.org/draft-07/schema", - "title": "Minify plugin", + "title": "Minify HTML, JavaScript and CSS during the build", "type": "object", "properties": { "minify": { diff --git a/docs/schema/plugins/external/redirects.json b/docs/schema/plugins/external/redirects.json index 92189df9c..e05348695 100644 --- a/docs/schema/plugins/external/redirects.json +++ b/docs/schema/plugins/external/redirects.json @@ -1,27 +1,27 @@ { "$schema": "https://json-schema.org/draft-07/schema", - "title": "Redirects plugin", + "title": "Add redirects when moving pages to new locations", "type": "object", "properties": { "redirects": { - "markdownDescription": "https://github.com/datarobot/mkdocs-redirects", + "markdownDescription": "https://github.com/mkdocs/mkdocs-redirects", "type": "object", "properties": { "redirect_maps": { "title": "Mapping of Markdown files", - "markdownDescription": "https://github.com/datarobot/mkdocs-redirects#using", + "markdownDescription": "https://github.com/mkdocs/mkdocs-redirects#using", "type": "object", "patternProperties": { "\\.md$": { "oneOf": [ { "title": "Internal redirect", - "markdownDescription": "https://github.com/datarobot/mkdocs-redirects#using", + "markdownDescription": "https://github.com/mkdocs/mkdocs-redirects#using", "pattern": "\\.md(#\\S+)?$" }, { "title": "External redirect", - "markdownDescription": "https://github.com/datarobot/mkdocs-redirects#using", + "markdownDescription": "https://github.com/mkdocs/mkdocs-redirects#using", "pattern": "^https?:" } ] diff --git a/docs/schema/plugins/external/section-index.json b/docs/schema/plugins/external/section-index.json index da191bcb4..66bf9cda6 100644 --- a/docs/schema/plugins/external/section-index.json +++ b/docs/schema/plugins/external/section-index.json @@ -1,6 +1,6 @@ { "$schema": "https://json-schema.org/draft-07/schema", - "title": "MkDocs plugin to allow clickable sections that lead to an index page", + "title": "Add index section pages to navigation", "oneOf": [ { "markdownDescription": "https://github.com/oprypin/mkdocs-section-index", @@ -12,8 +12,8 @@ "type": "object", "additionalProperties": false, "properties": { - "section-index": { - } + "section-index": {} } - }] + } + ] }