diff --git a/docs/schema/plugins/blog.json b/docs/schema/plugins/blog.json index 070fd839f..0163ec227 100644 --- a/docs/schema/plugins/blog.json +++ b/docs/schema/plugins/blog.json @@ -3,7 +3,7 @@ "title": "Built-in blog plugin", "oneOf": [ { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#built-in-blog-plugin", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/", "enum": [ "blog" ] @@ -12,36 +12,37 @@ "type": "object", "properties": { "blog": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#built-in-blog-plugin", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/", "type": "object", "properties": { "enabled": { "title": "Enable plugin", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.enabled", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.enabled", "type": "boolean", "default": true }, "blog_dir": { "title": "Blog directory", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.blog_dir", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.blog_dir", "type": "string", "default": "blog" }, "blog_toc": { "title": "Blog table of contents", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.blog_toc", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.blog_toc", "type": "boolean", "default": false }, "post_dir": { "title": "Blog posts directory", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.post_dir", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_dir", "type": "string", - "default": "\"{blog}/posts\"" + "default": "\"{blog\\}/posts\"" }, "post_date_format": { "title": "Format string for post dates", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.post_date_format", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_date_format", + "default": "long", "oneOf": [ { "enum": [ @@ -54,12 +55,11 @@ { "type": "string" } - ], - "default": "long" + ] }, "post_url_date_format": { "title": "Format string for post dates in URLs", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.post_url_date_format", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_url_date_format", "oneOf": [ { "enum": [ @@ -76,7 +76,7 @@ }, "post_url_format": { "title": "Format string for post URLs", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.post_url_format", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_url_format", "oneOf": [ { "enum": [ @@ -93,24 +93,24 @@ }, "post_url_max_categories": { "title": "Number of categories in post URLs", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.post_url_max_categories", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_url_max_categories", "type": "number", "default": 1 }, "post_slugify": { "title": "Post slugify function", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.post_slugify", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_slugify", "default": "!!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}" }, "post_slugify_separator": { "title": "Post slugify separator", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.post_slugify_separator", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_slugify_separator", "type": "string", "default": "\"-\"" }, "post_excerpt": { "title": "Post excerpts", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.post_excerpt", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_excerpt", "oneOf": [ { "title": "Post excerpts are optional", @@ -129,49 +129,49 @@ }, "post_excerpt_max_authors": { "title": "Number of authors to render in post excerpts", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.post_excerpt_max_authors", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_excerpt_max_authors", "type": "number", "default": 1 }, "post_excerpt_max_categories": { "title": "Number of categories to render in post excerpts", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.post_excerpt_max_categories", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_excerpt_max_categories", "type": "number", "default": 5 }, "post_excerpt_separator": { "title": "Post excerpt separator", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.post_excerpt_separator", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_excerpt_separator", "type": "string", "default": "" }, "post_readtime": { "title": "Post reading time computation", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.post_readtime", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_readtime", "type": "boolean", "default": true }, "post_readtime_words_per_minute": { "title": "Post reading time words per minute", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.post_readtime_words_per_minute", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_readtime_words_per_minute", "type": "number", "default": 265 }, "archive": { "title": "Archive", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.archive", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive", "type": "boolean", "default": true }, "archive_name": { "title": "Archive name", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.archive_name", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_name", "type": "string", "default": "Archive" }, "archive_date_format": { "title": "Format string for archive dates", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.archive_date_format", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_date_format", "oneOf": [ { "enum": [ @@ -187,7 +187,7 @@ }, "archive_url_date_format": { "title": "Format string for archive dates in URLs", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.archive_url_date_format", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_url_date_format", "oneOf": [ { "enum": [ @@ -203,7 +203,7 @@ }, "archive_url_format": { "title": "Format string for archive URLs", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.archive_url_format", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_url_format", "oneOf": [ { "enum": [ @@ -217,25 +217,25 @@ }, "archive_toc": { "title": "Archive table of contents", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.archive_toc", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_toc", "type": "boolean", "default": false }, "categories": { "title": "Categories", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.categories", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories", "type": "boolean", "default": true }, "categories_name": { "title": "Categories name", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.categories_name", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_name", "type": "string", "default": "Categories" }, "categories_url_format": { "title": "Format string for category URLs", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.categories_url_format", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_url_format", "oneOf": [ { "enum": [ @@ -250,18 +250,18 @@ }, "categories_slugify": { "title": "Categories slugify function", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.categories_slugify", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_slugify", "default": "!!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}" }, "categories_slugify_separator": { "title": "Categories slugify separator", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.categories_slugify_separator", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_slugify_separator", "type": "string", "default": "\"-\"" }, "categories_allowed": { "title": "Categories allowed", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.categories_allowed", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_allowed", "type": "array", "items": { "type": "string" @@ -271,25 +271,25 @@ }, "categories_toc": { "title": "Categories table of contents", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.categories_toc", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_toc", "type": "boolean", "default": false }, "pagination": { "title": "Pagination", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.pagination", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.pagination", "type": "boolean", "default": true }, "pagination_per_page": { "title": "Posts per page", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.pagination_per_page", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.pagination_per_page", "type": "number", "default": 10 }, "pagination_url_format": { "title": "Format string for pagination URLs", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.pagination_url_format", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.pagination_url_format", "oneOf": [ { "enum": [ @@ -304,7 +304,7 @@ }, "pagination_template": { "title": "Template string for pagination", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.pagination_template", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.pagination_template", "oneOf": [ { "enum": [ @@ -321,37 +321,37 @@ }, "pagination_keep_content": { "title": "Paginated indexes inherit content", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.pagination_keep_content", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.pagination_keep_content", "type": "boolean", "default": false }, "authors": { "title": "Author info", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.authors", + "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/setup/setting-up-a-blog/#+blog.authors_file", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_file", "type": "string", - "default": "\"{blog}/.authors.yml\"" + "default": "\"{blog\\}/.authors.yml\"" }, "draft": { "title": "Render posts marked as drafts", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.draft", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.draft", "type": "boolean", "default": false }, "draft_on_serve": { "title": "Render posts marked as drafts when previewing", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.draft_on_serve", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.draft_on_serve", "type": "boolean", "default": true }, "draft_if_future_date": { "title": "Automatically mark posts with future dates as drafts", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.draft_if_future_date", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.draft_if_future_date", "type": "boolean", "default": false } diff --git a/docs/schema/plugins/group.json b/docs/schema/plugins/group.json index 99d75540d..f5c564703 100644 --- a/docs/schema/plugins/group.json +++ b/docs/schema/plugins/group.json @@ -6,16 +6,17 @@ "type": "object", "properties": { "group": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/insiders/getting-started/#built-in-group-plugin", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/group/", "type": "object", "properties": { "enabled": { "title": "Enable plugin", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/insiders/getting-started/#+group.enabled", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/group/#config.enabled", "type": "boolean", "default": true }, "plugins": { + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/group/#config.plugins", "$ref": "../plugins.json" } }, diff --git a/docs/schema/plugins/info.json b/docs/schema/plugins/info.json index 26cc6236a..f026b010c 100644 --- a/docs/schema/plugins/info.json +++ b/docs/schema/plugins/info.json @@ -3,7 +3,7 @@ "title": "Built-in info plugin", "oneOf": [ { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/reporting-an-issue/#creating-a-zip-file", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/info/", "enum": [ "info" ] @@ -12,12 +12,30 @@ "type": "object", "properties": { "info": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/reporting-an-issue/#creating-a-zip-file", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/info/", "type": "object", "properties": { "enabled": { "title": "Enable plugin", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/reporting-an-issue/#creating-a-zip-file", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/info/#config.enabled", + "type": "boolean", + "default": true + }, + "enabled_on_serve": { + "title": "Enable plugin when previewing", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/info/#config.enabled_on_serve", + "type": "boolean", + "default": false + }, + "archive": { + "title": "Enable creation of archive", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/info/#config.archive", + "type": "boolean", + "default": true + }, + "archive_stop_on_violation": { + "title": "Stop creation of archive on violation", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/info/#config.archive_stop_on_violation", "type": "boolean", "default": true } diff --git a/docs/schema/plugins/meta.json b/docs/schema/plugins/meta.json index aef3495dd..4aa12445e 100644 --- a/docs/schema/plugins/meta.json +++ b/docs/schema/plugins/meta.json @@ -3,7 +3,7 @@ "title": "Built-in meta plugin", "oneOf": [ { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/#built-in-meta-plugin", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/meta/", "enum": [ "meta" ] @@ -12,12 +12,18 @@ "type": "object", "properties": { "meta": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/#built-in-meta-plugin", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/meta/", "type": "object", "properties": { + "enabled": { + "title": "Enable plugin", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/meta/#config.enabled", + "type": "boolean", + "default": true + }, "meta_file": { "title": "Meta file name", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/#+meta.meta_file", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/meta/#config.meta_file", "pattern": "\\.yml$", "default": "\"**/.meta.yml\"" } diff --git a/docs/schema/plugins/offline.json b/docs/schema/plugins/offline.json index e97b620aa..3c0f5ea65 100644 --- a/docs/schema/plugins/offline.json +++ b/docs/schema/plugins/offline.json @@ -3,7 +3,7 @@ "title": "Built-in offline plugin", "oneOf": [ { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-for-offline-usage/#built-in-offline-plugin", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/offline/", "enum": [ "offline" ] @@ -12,12 +12,12 @@ "type": "object", "properties": { "offline": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-for-offline-usage/#built-in-offline-plugin", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/offline/", "type": "object", "properties": { "enabled": { "title": "Enable plugin", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-for-offline-usage/#+offline.enabled", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/offline/#config.enabled", "type": "boolean", "default": true } diff --git a/docs/schema/plugins/optimize.json b/docs/schema/plugins/optimize.json index c7c80c44d..346eee078 100644 --- a/docs/schema/plugins/optimize.json +++ b/docs/schema/plugins/optimize.json @@ -3,7 +3,7 @@ "title": "Built-in optimize plugin", "oneOf": [ { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#built-in-optimize-plugin", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/", "enum": [ "optimize" ] @@ -12,75 +12,101 @@ "type": "object", "properties": { "optimize": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#built-in-optimize-plugin", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/", "type": "object", "properties": { "enabled": { "title": "Enable plugin", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.enabled", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.enabled", "type": "boolean", "default": true }, "concurrency": { "title": "Concurrency (number of CPUs)", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.concurrency", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.concurrency", "type": "number" }, "cache": { "title": "Enable caching", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.cache", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.cache", "type": "boolean", "default": true }, "cache_dir": { "title": "Cache directory", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.cache_dir", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.cache_dir", "type": "string", - "default": ".cache/plugins/social" + "default": ".cache/plugins/optimize" }, "optimize_png": { "title": "Optimization of PNGs", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_png", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_png", "type": "boolean", "default": true }, "optimize_png_speed": { "title": "Speed/quality tradeoff [1,10]", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_png_speed", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_png_speed", "type": "number", "default": 4 }, "optimize_png_strip": { "title": "Strip unnecessary metadata from PNGs", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_png_strip", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_png_strip", "type": "boolean", "default": true }, "optimize_jpg": { "title": "Optimization of JPGs", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_jpg", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_jpg", "type": "boolean", "default": true }, "optimize_jpg_quality": { "title": "Speed/quality tradeoff for pngquant [0,10]", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_jpg_quality", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_jpg_quality", "type": "number", "default": 60 }, "optimize_jpg_progressive": { "title": "Progressive encoding (faster rendering)", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_jpg_progressive", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_jpg_progressive", "type": "boolean", "default": true }, + "optimize_include": { + "title": "Files or folders to include", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_include", + "type": "array", + "items": { + "title": "Files or folders matching this pattern will be included", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_include", + "pattern": ".*" + }, + "uniqueItems": true, + "minItems": 1 + }, + "optimize_exclude": { + "title": "Files or folders to exclude", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_exclude", + "type": "array", + "items": { + "title": "Files or folders matching this pattern will be excluded", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_exclude", + "pattern": ".*" + }, + "uniqueItems": true, + "minItems": 1 + }, "print_gain": { "title": "Print optimization gain", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.print_gain", "type": "boolean", "default": true }, "print_gain_summary": { "title": "Print optimization gain summary", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.print_gain_summary", "type": "boolean", "default": true } diff --git a/docs/schema/plugins/privacy.json b/docs/schema/plugins/privacy.json index b5483e52e..85593a117 100644 --- a/docs/schema/plugins/privacy.json +++ b/docs/schema/plugins/privacy.json @@ -3,7 +3,7 @@ "title": "Built-in privacy plugin", "oneOf": [ { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#built-in-privacy-plugin", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/", "enum": [ "privacy" ] @@ -12,45 +12,57 @@ "type": "object", "properties": { "privacy": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#built-in-privacy-plugin", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/", "type": "object", "properties": { "enabled": { "title": "Enable plugin", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.enabled", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.enabled", "type": "boolean", "default": true }, "concurrency": { "title": "Concurrency (number of CPUs)", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.concurrency", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.concurrency", "type": "number" }, + "cache": { + "title": "Enable caching", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.cache", + "type": "boolean", + "default": true + }, + "cache_dir": { + "title": "Cache directory", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.cache_dir", + "type": "string", + "default": ".cache/plugins/privacy" + }, "assets": { "title": "Process external assets", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.assets", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.assets", "type": "boolean", "default": true }, "assets_fetch": { "title": "Download external assets", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.assets_fetch", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.assets_fetch", "type": "boolean", "default": true }, "assets_fetch_dir": { "title": "Download external assets to this directory", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.assets_fetch_dir", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.assets_fetch_dir", "type": "string", "default": "assets/external" }, "assets_include": { "title": "External assets to include", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.assets_include", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.assets_include", "type": "array", "items": { "title": "External assets matching this pattern will be downloaded", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.assets_include", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.assets_include", "pattern": ".*" }, "uniqueItems": true, @@ -58,11 +70,11 @@ }, "assets_exclude": { "title": "External assets to exclude", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.assets_exclude", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.assets_exclude", "type": "array", "items": { "title": "External assets matching this pattern will not be downloaded", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.assets_exclude", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.assets_exclude", "pattern": ".*" }, "uniqueItems": true, @@ -70,13 +82,13 @@ }, "links": { "title": "Process external links", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.links", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.links", "type": "boolean", "default": true }, "links_attr_map": { "title": "Custom attributes to add to external links", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.links_attr_map", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.links_attr_map", "type": "object", "patternProperties": { "^[\\w_]+$": { @@ -86,7 +98,7 @@ }, "links_noopener": { "title": "Behavior for external links that open in new windows", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.links_noopener", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.links_noopener", "type": "boolean", "default": true } diff --git a/docs/schema/plugins/projects.json b/docs/schema/plugins/projects.json index 8d433ff6a..7ed61e2e1 100644 --- a/docs/schema/plugins/projects.json +++ b/docs/schema/plugins/projects.json @@ -3,7 +3,7 @@ "title": "Built-in projects plugin", "oneOf": [ { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#built-in-projects-plugin", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/", "enum": [ "projects" ] @@ -12,35 +12,47 @@ "type": "object", "properties": { "projects": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#built-in-projects-plugin", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/", "type": "object", "properties": { "enabled": { "title": "Enable plugin", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+projects.enabled", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.enabled", "type": "boolean", "default": true }, "concurrency": { "title": "Concurrency (number of CPUs)", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+projects.concurrency", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.concurrency", "type": "number" }, + "cache": { + "title": "Enable caching", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.cache", + "type": "boolean", + "default": true + }, + "cache_dir": { + "title": "Cache directory", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.cache_dir", + "type": "string", + "default": ".cache/plugins/projects" + }, "projects": { "title": "Enable projects", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+projects.projects", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.projects", "type": "boolean", "default": true }, "projects_dir": { "title": "Projects directory", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+projects.projects_dir", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.projects_dir", "type": "string", "default": "projects" }, "hosting": { "title": "Enable hoisting", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+projects.hoisting", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.hoisting", "type": "boolean", "default": true } diff --git a/docs/schema/plugins/search.json b/docs/schema/plugins/search.json index bbd1641b5..68112b917 100644 --- a/docs/schema/plugins/search.json +++ b/docs/schema/plugins/search.json @@ -3,7 +3,7 @@ "title": "Built-in search plugin", "oneOf": [ { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#built-in-search-plugin", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/", "enum": [ "search" ] @@ -12,7 +12,7 @@ "type": "object", "properties": { "search": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#built-in-search-plugin", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/", "type": "object", "properties": { "lang": { @@ -33,12 +33,12 @@ }, "separator": { "title": "Separator for indexing and query tokenization", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#+search.separator", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/#config.separator", "type": "string" }, "pipeline": { "title": "Text processing pipeline for indexing", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#+search.pipeline", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/#config.pipeline", "type": "array", "items": { "enum": [ @@ -51,12 +51,12 @@ }, "jieba_dict": { "title": "Jieba dictionary replacement", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#+search.jieba_dict", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/#config.jieba_dict", "type": "string" }, "jieba_dict_user": { "title": "Jieba dictionary augmentation", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#+search.jieba_dict_user", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/#config.jieba_dict_user", "type": "string" } }, @@ -69,7 +69,7 @@ "definitions": { "lang": { "title": "Site search language", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#+search.lang", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/#config.lang", "oneOf": [ { "title": "Site search language: Arabic", diff --git a/docs/schema/plugins/social.json b/docs/schema/plugins/social.json index 678ea580b..efc29594a 100644 --- a/docs/schema/plugins/social.json +++ b/docs/schema/plugins/social.json @@ -3,7 +3,7 @@ "title": "Built-in social plugin", "oneOf": [ { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#built-in-social-plugin", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/", "enum": [ "social" ] @@ -12,61 +12,80 @@ "type": "object", "properties": { "social": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#built-in-social-plugin", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/", "type": "object", "properties": { "enabled": { "title": "Enable plugin", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.enabled", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.enabled", "type": "boolean", "default": true }, "concurrency": { "title": "Concurrency (number of CPUs)", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.concurrency", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.concurrency", "type": "number" }, + "cache": { + "title": "Enable caching", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cache", + "type": "boolean", + "default": true + }, + "cache_dir": { + "title": "Cache directory", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cache_dir", + "type": "string", + "default": ".cache/plugins/social" + }, "cards": { "title": "Social cards", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.cards", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cards", "type": "boolean", "default": true }, "cards_dir": { "title": "Social cards directory", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.cards_dir", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cards_dir", "type": "string", "default": "assets/images/social" }, "cards_layout_dir": { "title": "Social cards layout directory", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.cards_layout_dir", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cards_layout_dir", "type": "string", "default": "layouts" }, "cards_layout": { "title": "Social cards layout", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.cards_layout", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cards_layout", "default": "default", - "enum": [ - "default", - "default/accent", - "default/invert", - "default/variant" + "oneOf": [ + { + "enum": [ + "default", + "default/accent", + "default/invert", + "default/variant" + ] + }, + { + "type": "string" + } ] }, "cards_layout_options": { "title": "Social cards layout options", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.cards_layout_options", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cards_layout_options", "type": "object" }, "cards_include": { "title": "Pages or folders to include", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.cards_include", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cards_include", "type": "array", "items": { "title": "Pages or folders matching this pattern will be included", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.cards_include", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cards_include", "pattern": ".*" }, "uniqueItems": true, @@ -74,11 +93,11 @@ }, "cards_exclude": { "title": "Pages or folders to exclude", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.cards_exclude", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cards_exclude", "type": "array", "items": { "title": "Pages or folders matching this pattern will be excluded", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.cards_exclude", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cards_exclude", "pattern": ".*" }, "uniqueItems": true, @@ -86,45 +105,33 @@ }, "debug": { "title": "Debug mode", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.debug", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.debug", "type": "boolean", "default": true }, "debug_on_build": { "title": "Always disable debug mode on build", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.debug_on_build", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.debug_on_build", "type": "boolean", "default": false }, "debug_grid": { "title": "Debug grid", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.debug_grid", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.debug_grid", "type": "boolean", "default": true }, "debug_grid_step": { "title": "Debug grid step size", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.debug_grid_step", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.debug_grid_step", "type": "number", "default": 32 }, "debug_color": { "title": "Debug color", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.debug_color", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.debug_color", "type": "string", "default": "yellow" - }, - "cache": { - "title": "Enable caching", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.cache", - "type": "boolean", - "default": true - }, - "cache_dir": { - "title": "Cache directory", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.cache_dir", - "type": "string", - "default": ".cache/plugins/social" } }, "additionalProperties": false diff --git a/docs/schema/plugins/tags.json b/docs/schema/plugins/tags.json index 68359297e..b85385796 100644 --- a/docs/schema/plugins/tags.json +++ b/docs/schema/plugins/tags.json @@ -3,7 +3,7 @@ "title": "Built-in tags plugin", "oneOf": [ { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#built-in-tags-plugin", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/", "enum": [ "tags" ] @@ -12,24 +12,24 @@ "type": "object", "properties": { "tags": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#built-in-tags-plugin", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/", "type": "object", "properties": { "enabled": { "title": "Enable plugin", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#+tags.enabled", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.enabled", "type": "boolean", "default": true }, "tags_file": { "title": "Markdown file to render tags index", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#+tags.tags_file", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.tags_file", "pattern": "\\.md$", "default": "tags.md" }, "tags_extra_files": { "title": "Markdown files to render additional tags indexes", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#+tags.tags_extra_files", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.tags_extra_files", "type": "object", "patternProperties": { "\\.md$": { @@ -44,38 +44,38 @@ }, "tags_slugify": { "title": "Tags slugify function", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#+tags.tags_slugify", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.tags_slugify", "default": "!!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}" }, "tags_slugify_separator": { "title": "Tags slugify separator", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#+tags.tags_slugify_separator", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.tags_slugify_separator", "type": "string", "default": "\"-\"" }, "tags_compare": { "title": "Sort tags by this function", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#+tags.tags_compare", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.tags_compare", "default": "!!python/name:material.plugins.tags.casefold" }, "tags_compare_reverse": { "title": "Soft tags in reverse", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#+tags.tags_compare_reverse", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.tags_compare_reverse", "default": false }, "tags_pages_compare": { "title": "Sort tags pages by this function", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#+tags.tags_pages_compare", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.tags_pages_compare", "default": "!!python/name:material.plugins.tags.page_title" }, "tags_pages_compare_reverse": { "title": "Soft tags pages in reverse", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#+tags.tags_pages_compare_reverse", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.tags_pages_compare_reverse", "default": false }, "tags_allowed": { "title": "Tags allowed", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#+tags.tags_allowed", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.tags_allowed", "type": "array", "items": { "type": "string" diff --git a/docs/schema/plugins/typeset.json b/docs/schema/plugins/typeset.json index cb393e50f..d6fcdb188 100644 --- a/docs/schema/plugins/typeset.json +++ b/docs/schema/plugins/typeset.json @@ -3,7 +3,7 @@ "title": "Built-in typeset plugin", "oneOf": [ { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/#built-in-typeset-plugin", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/typeset/", "enum": [ "typeset" ] @@ -12,12 +12,12 @@ "type": "object", "properties": { "typeset": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/#built-in-typeset-plugin", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/typeset/", "type": "object", "properties": { "enabled": { "title": "Enable plugin", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/#+typeset.enabled", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/typeset/#config.enabled", "type": "boolean", "default": true }