From c81befb4ece9befb08c7c32cc847a749e139c133 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sun, 26 Nov 2023 15:33:54 +0100 Subject: [PATCH] Updated JSON schema --- docs/schema/plugins/blog.json | 83 +++++++++++++++++++++++++++-------- 1 file changed, 64 insertions(+), 19 deletions(-) diff --git a/docs/schema/plugins/blog.json b/docs/schema/plugins/blog.json index aaf4ba305..ef46b43ee 100644 --- a/docs/schema/plugins/blog.json +++ b/docs/schema/plugins/blog.json @@ -26,13 +26,13 @@ "default": "blog" }, "blog_toc": { - "title": "Blog table of contents", + "title": "Table of contents", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.blog_toc", "type": "boolean", "default": false }, "post_dir": { - "title": "Blog posts directory", + "title": "Post directory", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_dir", "type": "string", "default": "\"{blog\\}/posts\"" @@ -210,19 +210,19 @@ ] }, "archive_pagination": { - "title": "Pagination for archive pages", + "title": "Pagination for archive", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_pagination", "type": "boolean", "default": true }, "archive_pagination_per_page": { - "title": "Posts per page for archive pages", + "title": "Posts per page for archive", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_pagination_per_page", "type": "number", "default": 10 }, "archive_toc": { - "title": "Archive table of contents", + "title": "Table of contents for archive", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_toc", "type": "boolean", "default": false @@ -287,7 +287,7 @@ "default": false }, "categories_allowed": { - "title": "Categories allowed", + "title": "Allowed categories", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_allowed", "type": "array", "items": { @@ -309,11 +309,68 @@ "default": 10 }, "categories_toc": { - "title": "Categories table of contents", + "title": "Table of contents for categories", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_toc", "type": "boolean", "default": false }, + "authors": { + "title": "Author info", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors", + "type": "boolean", + "default": true + }, + "authors_file": { + "title": "Authors file", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_file", + "type": "string", + "default": "\"{blog}/.authors.yml\"" + }, + "authors_profiles": { + "title": "Author profiles", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_profiles", + "type": "boolean", + "default": false + }, + "authors_profiles_name": { + "title": "Authors profiles name", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_profiles_name", + "type": "string", + "default": "Authors" + }, + "authors_profiles_url_format": { + "title": "Format string for author profile URLs", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_profiles_url_format", + "oneOf": [ + { + "enum": [ + "\"author/{slug}\"", + "\"{slug}\"" + ] + }, + { + "type": "string" + } + ] + }, + "authors_profiles_pagination": { + "title": "Pagination for author profiles", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_profiles_pagination", + "type": "boolean", + "default": true + }, + "authors_profiles_pagination_per_page": { + "title": "Posts per page for author profiles", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_profiles_pagination_per_page", + "type": "number", + "default": 10 + }, + "authors_profiles_toc": { + "title": "Table of contents for author profiles", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_profiles_toc", + "type": "boolean", + "default": false + }, "pagination": { "title": "Pagination", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.pagination", @@ -364,18 +421,6 @@ "type": "boolean", "default": false }, - "authors": { - "title": "Author info", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors", - "type": "boolean", - "default": true - }, - "authors_file": { - "title": "Authors file", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_file", - "type": "string", - "default": "\"{blog\\}/.authors.yml\"" - }, "draft": { "title": "Render posts marked as drafts", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.draft",