OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Fixed links to plugin settings in JSON schema

Browse Source
This commit is contained in:
squidfunk 2023-09-15 11:30:01 +02:00
parent d373e7a7ee
commit 96560b82c9
No known key found for this signature in database
GPG Key ID: 5ED40BC4F9C436DF
12 changed files with 229 additions and 147 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

90
docs/schema/plugins/blog.json
View File

@ -3,7 +3,7 @@
"title": "Built-in blog plugin", "title": "Built-in blog plugin",
"oneOf": [ "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": [ "enum": [
"blog" "blog"
] ]
@ -12,36 +12,37 @@
"type": "object", "type": "object",
"properties": { "properties": {
"blog": { "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", "type": "object",
"properties": { "properties": {
"enabled": { "enabled": {
"title": "Enable plugin", "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", "type": "boolean",
"default": true "default": true
}, },
"blog_dir": { "blog_dir": {
"title": "Blog directory", "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", "type": "string",
"default": "blog" "default": "blog"
}, },
"blog_toc": { "blog_toc": {
"title": "Blog table of contents", "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", "type": "boolean",
"default": false "default": false
}, },
"post_dir": { "post_dir": {
"title": "Blog posts directory", "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", "type": "string",
"default": "\"{blog}/posts\"" "default": "\"{blog\\}/posts\""
}, },
"post_date_format": { "post_date_format": {
"title": "Format string for post dates", "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": [ "oneOf": [
{ {
"enum": [ "enum": [
@ -54,12 +55,11 @@
{ {
"type": "string" "type": "string"
} }
], ]
"default": "long"
}, },
"post_url_date_format": { "post_url_date_format": {
"title": "Format string for post dates in URLs", "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": [ "oneOf": [
{ {
"enum": [ "enum": [
@ -76,7 +76,7 @@
}, },
"post_url_format": { "post_url_format": {
"title": "Format string for post URLs", "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": [ "oneOf": [
{ {
"enum": [ "enum": [
@ -93,24 +93,24 @@
}, },
"post_url_max_categories": { "post_url_max_categories": {
"title": "Number of categories in post URLs", "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", "type": "number",
"default": 1 "default": 1
}, },
"post_slugify": { "post_slugify": {
"title": "Post slugify function", "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}}" "default": "!!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}"
}, },
"post_slugify_separator": { "post_slugify_separator": {
"title": "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", "type": "string",
"default": "\"-\"" "default": "\"-\""
}, },
"post_excerpt": { "post_excerpt": {
"title": "Post excerpts", "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": [ "oneOf": [
{ {
"title": "Post excerpts are optional", "title": "Post excerpts are optional",
@ -129,49 +129,49 @@
}, },
"post_excerpt_max_authors": { "post_excerpt_max_authors": {
"title": "Number of authors to render in post excerpts", "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", "type": "number",
"default": 1 "default": 1
}, },
"post_excerpt_max_categories": { "post_excerpt_max_categories": {
"title": "Number of categories to render in post excerpts", "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", "type": "number",
"default": 5 "default": 5
}, },
"post_excerpt_separator": { "post_excerpt_separator": {
"title": "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", "type": "string",
"default": "<!-- more -->" "default": "<!-- more -->"
}, },
"post_readtime": { "post_readtime": {
"title": "Post reading time computation", "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", "type": "boolean",
"default": true "default": true
}, },
"post_readtime_words_per_minute": { "post_readtime_words_per_minute": {
"title": "Post reading time 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", "type": "number",
"default": 265 "default": 265
}, },
"archive": { "archive": {
"title": "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", "type": "boolean",
"default": true "default": true
}, },
"archive_name": { "archive_name": {
"title": "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", "type": "string",
"default": "Archive" "default": "Archive"
}, },
"archive_date_format": { "archive_date_format": {
"title": "Format string for archive dates", "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": [ "oneOf": [
{ {
"enum": [ "enum": [
@ -187,7 +187,7 @@
}, },
"archive_url_date_format": { "archive_url_date_format": {
"title": "Format string for archive dates in URLs", "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": [ "oneOf": [
{ {
"enum": [ "enum": [
@ -203,7 +203,7 @@
}, },
"archive_url_format": { "archive_url_format": {
"title": "Format string for archive URLs", "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": [ "oneOf": [
{ {
"enum": [ "enum": [
@ -217,25 +217,25 @@
}, },
"archive_toc": { "archive_toc": {
"title": "Archive table of contents", "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", "type": "boolean",
"default": false "default": false
}, },
"categories": { "categories": {
"title": "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", "type": "boolean",
"default": true "default": true
}, },
"categories_name": { "categories_name": {
"title": "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", "type": "string",
"default": "Categories" "default": "Categories"
}, },
"categories_url_format": { "categories_url_format": {
"title": "Format string for category URLs", "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": [ "oneOf": [
{ {
"enum": [ "enum": [
@ -250,18 +250,18 @@
}, },
"categories_slugify": { "categories_slugify": {
"title": "Categories slugify function", "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}}" "default": "!!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}"
}, },
"categories_slugify_separator": { "categories_slugify_separator": {
"title": "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", "type": "string",
"default": "\"-\"" "default": "\"-\""
}, },
"categories_allowed": { "categories_allowed": {
"title": "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", "type": "array",
"items": { "items": {
"type": "string" "type": "string"
@ -271,25 +271,25 @@
}, },
"categories_toc": { "categories_toc": {
"title": "Categories table of contents", "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", "type": "boolean",
"default": false "default": false
}, },
"pagination": { "pagination": {
"title": "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", "type": "boolean",
"default": true "default": true
}, },
"pagination_per_page": { "pagination_per_page": {
"title": "Posts 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", "type": "number",
"default": 10 "default": 10
}, },
"pagination_url_format": { "pagination_url_format": {
"title": "Format string for pagination URLs", "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": [ "oneOf": [
{ {
"enum": [ "enum": [
@ -304,7 +304,7 @@
}, },
"pagination_template": { "pagination_template": {
"title": "Template string for pagination", "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": [ "oneOf": [
{ {
"enum": [ "enum": [
@ -321,37 +321,37 @@
}, },
"pagination_keep_content": { "pagination_keep_content": {
"title": "Paginated indexes inherit 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", "type": "boolean",
"default": false "default": false
}, },
"authors": { "authors": {
"title": "Author info", "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", "type": "boolean",
"default": true "default": true
}, },
"authors_file": { "authors_file": {
"title": "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", "type": "string",
"default": "\"{blog}/.authors.yml\"" "default": "\"{blog\\}/.authors.yml\""
}, },
"draft": { "draft": {
"title": "Render posts marked as drafts", "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", "type": "boolean",
"default": false "default": false
}, },
"draft_on_serve": { "draft_on_serve": {
"title": "Render posts marked as drafts when previewing", "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", "type": "boolean",
"default": true "default": true
}, },
"draft_if_future_date": { "draft_if_future_date": {
"title": "Automatically mark posts with future dates as drafts", "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", "type": "boolean",
"default": false "default": false
} }

5
docs/schema/plugins/group.json
View File

@ -6,16 +6,17 @@
"type": "object", "type": "object",
"properties": { "properties": {
"group": { "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", "type": "object",
"properties": { "properties": {
"enabled": { "enabled": {
"title": "Enable plugin", "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", "type": "boolean",
"default": true "default": true
}, },
"plugins": { "plugins": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/group/#config.plugins",
"$ref": "../plugins.json" "$ref": "../plugins.json"
} }
}, },

24
docs/schema/plugins/info.json
View File

@ -3,7 +3,7 @@
"title": "Built-in info plugin", "title": "Built-in info plugin",
"oneOf": [ "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": [ "enum": [
"info" "info"
] ]
@ -12,12 +12,30 @@
"type": "object", "type": "object",
"properties": { "properties": {
"info": { "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", "type": "object",
"properties": { "properties": {
"enabled": { "enabled": {
"title": "Enable plugin", "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", "type": "boolean",
"default": true "default": true
} }

12
docs/schema/plugins/meta.json
View File

@ -3,7 +3,7 @@
"title": "Built-in meta plugin", "title": "Built-in meta plugin",
"oneOf": [ "oneOf": [
{ {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/#built-in-meta-plugin", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/meta/",
"enum": [ "enum": [
"meta" "meta"
] ]
@ -12,12 +12,18 @@
"type": "object", "type": "object",
"properties": { "properties": {
"meta": { "meta": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/#built-in-meta-plugin", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/meta/",
"type": "object", "type": "object",
"properties": { "properties": {
"enabled": {
"title": "Enable plugin",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/meta/#config.enabled",
"type": "boolean",
"default": true
},
"meta_file": { "meta_file": {
"title": "Meta file name", "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$", "pattern": "\\.yml$",
"default": "\"**/.meta.yml\"" "default": "\"**/.meta.yml\""
} }

6
docs/schema/plugins/offline.json
View File

@ -3,7 +3,7 @@
"title": "Built-in offline plugin", "title": "Built-in offline plugin",
"oneOf": [ "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": [ "enum": [
"offline" "offline"
] ]
@ -12,12 +12,12 @@
"type": "object", "type": "object",
"properties": { "properties": {
"offline": { "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", "type": "object",
"properties": { "properties": {
"enabled": { "enabled": {
"title": "Enable plugin", "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", "type": "boolean",
"default": true "default": true
} }

52
docs/schema/plugins/optimize.json
View File

@ -3,7 +3,7 @@
"title": "Built-in optimize plugin", "title": "Built-in optimize plugin",
"oneOf": [ "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": [ "enum": [
"optimize" "optimize"
] ]
@ -12,75 +12,101 @@
"type": "object", "type": "object",
"properties": { "properties": {
"optimize": { "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", "type": "object",
"properties": { "properties": {
"enabled": { "enabled": {
"title": "Enable plugin", "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", "type": "boolean",
"default": true "default": true
}, },
"concurrency": { "concurrency": {
"title": "Concurrency (number of CPUs)", "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" "type": "number"
}, },
"cache": { "cache": {
"title": "Enable caching", "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", "type": "boolean",
"default": true "default": true
}, },
"cache_dir": { "cache_dir": {
"title": "Cache directory", "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", "type": "string",
"default": ".cache/plugins/social" "default": ".cache/plugins/optimize"
}, },
"optimize_png": { "optimize_png": {
"title": "Optimization of PNGs", "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", "type": "boolean",
"default": true "default": true
}, },
"optimize_png_speed": { "optimize_png_speed": {
"title": "Speed/quality tradeoff [1,10]", "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", "type": "number",
"default": 4 "default": 4
}, },
"optimize_png_strip": { "optimize_png_strip": {
"title": "Strip unnecessary metadata from PNGs", "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", "type": "boolean",
"default": true "default": true
}, },
"optimize_jpg": { "optimize_jpg": {
"title": "Optimization of JPGs", "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", "type": "boolean",
"default": true "default": true
}, },
"optimize_jpg_quality": { "optimize_jpg_quality": {
"title": "Speed/quality tradeoff for pngquant [0,10]", "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", "type": "number",
"default": 60 "default": 60
}, },
"optimize_jpg_progressive": { "optimize_jpg_progressive": {
"title": "Progressive encoding (faster rendering)", "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", "type": "boolean",
"default": true "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": { "print_gain": {
"title": "Print optimization gain", "title": "Print optimization gain",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.print_gain",
"type": "boolean", "type": "boolean",
"default": true "default": true
}, },
"print_gain_summary": { "print_gain_summary": {
"title": "Print optimization gain summary", "title": "Print optimization gain summary",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.print_gain_summary",
"type": "boolean", "type": "boolean",
"default": true "default": true
} }

40
docs/schema/plugins/privacy.json
View File

@ -3,7 +3,7 @@
"title": "Built-in privacy plugin", "title": "Built-in privacy plugin",
"oneOf": [ "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": [ "enum": [
"privacy" "privacy"
] ]
@ -12,45 +12,57 @@
"type": "object", "type": "object",
"properties": { "properties": {
"privacy": { "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", "type": "object",
"properties": { "properties": {
"enabled": { "enabled": {
"title": "Enable plugin", "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", "type": "boolean",
"default": true "default": true
}, },
"concurrency": { "concurrency": {
"title": "Concurrency (number of CPUs)", "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" "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": { "assets": {
"title": "Process external 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", "type": "boolean",
"default": true "default": true
}, },
"assets_fetch": { "assets_fetch": {
"title": "Download external assets", "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", "type": "boolean",
"default": true "default": true
}, },
"assets_fetch_dir": { "assets_fetch_dir": {
"title": "Download external assets to this directory", "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", "type": "string",
"default": "assets/external" "default": "assets/external"
}, },
"assets_include": { "assets_include": {
"title": "External assets to 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", "type": "array",
"items": { "items": {
"title": "External assets matching this pattern will be downloaded", "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": ".*" "pattern": ".*"
}, },
"uniqueItems": true, "uniqueItems": true,
@ -58,11 +70,11 @@
}, },
"assets_exclude": { "assets_exclude": {
"title": "External assets to 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", "type": "array",
"items": { "items": {
"title": "External assets matching this pattern will not be downloaded", "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": ".*" "pattern": ".*"
}, },
"uniqueItems": true, "uniqueItems": true,
@ -70,13 +82,13 @@
}, },
"links": { "links": {
"title": "Process external 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", "type": "boolean",
"default": true "default": true
}, },
"links_attr_map": { "links_attr_map": {
"title": "Custom attributes to add to external links", "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", "type": "object",
"patternProperties": { "patternProperties": {
"^[\\w_]+$": { "^[\\w_]+$": {
@ -86,7 +98,7 @@
}, },
"links_noopener": { "links_noopener": {
"title": "Behavior for external links that open in new windows", "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", "type": "boolean",
"default": true "default": true
} }

26
docs/schema/plugins/projects.json
View File

@ -3,7 +3,7 @@
"title": "Built-in projects plugin", "title": "Built-in projects plugin",
"oneOf": [ "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": [ "enum": [
"projects" "projects"
] ]
@ -12,35 +12,47 @@
"type": "object", "type": "object",
"properties": { "properties": {
"projects": { "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", "type": "object",
"properties": { "properties": {
"enabled": { "enabled": {
"title": "Enable plugin", "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", "type": "boolean",
"default": true "default": true
}, },
"concurrency": { "concurrency": {
"title": "Concurrency (number of CPUs)", "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" "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": { "projects": {
"title": "Enable 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", "type": "boolean",
"default": true "default": true
}, },
"projects_dir": { "projects_dir": {
"title": "Projects directory", "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", "type": "string",
"default": "projects" "default": "projects"
}, },
"hosting": { "hosting": {
"title": "Enable hoisting", "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", "type": "boolean",
"default": true "default": true
} }

14
docs/schema/plugins/search.json
View File

@ -3,7 +3,7 @@
"title": "Built-in search plugin", "title": "Built-in search plugin",
"oneOf": [ "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": [ "enum": [
"search" "search"
] ]
@ -12,7 +12,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"search": { "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", "type": "object",
"properties": { "properties": {
"lang": { "lang": {
@ -33,12 +33,12 @@
}, },
"separator": { "separator": {
"title": "Separator for indexing and query tokenization", "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" "type": "string"
}, },
"pipeline": { "pipeline": {
"title": "Text processing pipeline for indexing", "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", "type": "array",
"items": { "items": {
"enum": [ "enum": [
@ -51,12 +51,12 @@
}, },
"jieba_dict": { "jieba_dict": {
"title": "Jieba dictionary replacement", "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" "type": "string"
}, },
"jieba_dict_user": { "jieba_dict_user": {
"title": "Jieba dictionary augmentation", "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" "type": "string"
} }
}, },
@ -69,7 +69,7 @@
"definitions": { "definitions": {
"lang": { "lang": {
"title": "Site search language", "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": [ "oneOf": [
{ {
"title": "Site search language: Arabic", "title": "Site search language: Arabic",

67
docs/schema/plugins/social.json
View File

@ -3,7 +3,7 @@
"title": "Built-in social plugin", "title": "Built-in social plugin",
"oneOf": [ "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": [ "enum": [
"social" "social"
] ]
@ -12,42 +12,56 @@
"type": "object", "type": "object",
"properties": { "properties": {
"social": { "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", "type": "object",
"properties": { "properties": {
"enabled": { "enabled": {
"title": "Enable plugin", "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", "type": "boolean",
"default": true "default": true
}, },
"concurrency": { "concurrency": {
"title": "Concurrency (number of CPUs)", "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" "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": { "cards": {
"title": "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", "type": "boolean",
"default": true "default": true
}, },
"cards_dir": { "cards_dir": {
"title": "Social cards directory", "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", "type": "string",
"default": "assets/images/social" "default": "assets/images/social"
}, },
"cards_layout_dir": { "cards_layout_dir": {
"title": "Social cards layout directory", "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", "type": "string",
"default": "layouts" "default": "layouts"
}, },
"cards_layout": { "cards_layout": {
"title": "Social 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", "default": "default",
"oneOf": [
{
"enum": [ "enum": [
"default", "default",
"default/accent", "default/accent",
@ -55,18 +69,23 @@
"default/variant" "default/variant"
] ]
}, },
{
"type": "string"
}
]
},
"cards_layout_options": { "cards_layout_options": {
"title": "Social 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" "type": "object"
}, },
"cards_include": { "cards_include": {
"title": "Pages or folders to 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", "type": "array",
"items": { "items": {
"title": "Pages or folders matching this pattern will be included", "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": ".*" "pattern": ".*"
}, },
"uniqueItems": true, "uniqueItems": true,
@ -74,11 +93,11 @@
}, },
"cards_exclude": { "cards_exclude": {
"title": "Pages or folders to 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", "type": "array",
"items": { "items": {
"title": "Pages or folders matching this pattern will be excluded", "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": ".*" "pattern": ".*"
}, },
"uniqueItems": true, "uniqueItems": true,
@ -86,45 +105,33 @@
}, },
"debug": { "debug": {
"title": "Debug mode", "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", "type": "boolean",
"default": true "default": true
}, },
"debug_on_build": { "debug_on_build": {
"title": "Always disable debug mode 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", "type": "boolean",
"default": false "default": false
}, },
"debug_grid": { "debug_grid": {
"title": "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", "type": "boolean",
"default": true "default": true
}, },
"debug_grid_step": { "debug_grid_step": {
"title": "Debug grid step size", "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", "type": "number",
"default": 32 "default": 32
}, },
"debug_color": { "debug_color": {
"title": "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", "type": "string",
"default": "yellow" "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 "additionalProperties": false

24
docs/schema/plugins/tags.json
View File

@ -3,7 +3,7 @@
"title": "Built-in tags plugin", "title": "Built-in tags plugin",
"oneOf": [ "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": [ "enum": [
"tags" "tags"
] ]
@ -12,24 +12,24 @@
"type": "object", "type": "object",
"properties": { "properties": {
"tags": { "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", "type": "object",
"properties": { "properties": {
"enabled": { "enabled": {
"title": "Enable plugin", "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", "type": "boolean",
"default": true "default": true
}, },
"tags_file": { "tags_file": {
"title": "Markdown file to render tags index", "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$", "pattern": "\\.md$",
"default": "tags.md" "default": "tags.md"
}, },
"tags_extra_files": { "tags_extra_files": {
"title": "Markdown files to render additional tags indexes", "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", "type": "object",
"patternProperties": { "patternProperties": {
"\\.md$": { "\\.md$": {
@ -44,38 +44,38 @@
}, },
"tags_slugify": { "tags_slugify": {
"title": "Tags slugify function", "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}}" "default": "!!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}"
}, },
"tags_slugify_separator": { "tags_slugify_separator": {
"title": "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", "type": "string",
"default": "\"-\"" "default": "\"-\""
}, },
"tags_compare": { "tags_compare": {
"title": "Sort tags by this function", "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" "default": "!!python/name:material.plugins.tags.casefold"
}, },
"tags_compare_reverse": { "tags_compare_reverse": {
"title": "Soft tags in 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 "default": false
}, },
"tags_pages_compare": { "tags_pages_compare": {
"title": "Sort tags pages by this function", "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" "default": "!!python/name:material.plugins.tags.page_title"
}, },
"tags_pages_compare_reverse": { "tags_pages_compare_reverse": {
"title": "Soft tags pages in 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 "default": false
}, },
"tags_allowed": { "tags_allowed": {
"title": "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", "type": "array",
"items": { "items": {
"type": "string" "type": "string"

6
docs/schema/plugins/typeset.json
View File

@ -3,7 +3,7 @@
"title": "Built-in typeset plugin", "title": "Built-in typeset plugin",
"oneOf": [ "oneOf": [
{ {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/#built-in-typeset-plugin", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/typeset/",
"enum": [ "enum": [
"typeset" "typeset"
] ]
@ -12,12 +12,12 @@
"type": "object", "type": "object",
"properties": { "properties": {
"typeset": { "typeset": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/#built-in-typeset-plugin", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/typeset/",
"type": "object", "type": "object",
"properties": { "properties": {
"enabled": { "enabled": {
"title": "Enable plugin", "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", "type": "boolean",
"default": true "default": true
} }