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

Updated JSON schema

Browse Source
This commit is contained in:
squidfunk 2023-11-26 15:33:54 +01:00
parent 6be485c38f
commit c81befb4ec
No known key found for this signature in database
GPG Key ID: 5ED40BC4F9C436DF
1 changed files with 64 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -26,13 +26,13 @@
"default": "blog" "default": "blog"
}, },
"blog_toc": { "blog_toc": {
"title": "Blog table of contents", "title": "Table of contents",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.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": "Post directory",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_dir", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_dir",
"type": "string", "type": "string",
"default": "\"{blog\\}/posts\"" "default": "\"{blog\\}/posts\""
@ -210,19 +210,19 @@
] ]
}, },
"archive_pagination": { "archive_pagination": {
"title": "Pagination for archive pages", "title": "Pagination for archive",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_pagination", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_pagination",
"type": "boolean", "type": "boolean",
"default": true "default": true
}, },
"archive_pagination_per_page": { "archive_pagination_per_page": {
"title": "Posts per page for archive pages", "title": "Posts per page for archive",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_pagination_per_page", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_pagination_per_page",
"type": "number", "type": "number",
"default": 10 "default": 10
}, },
"archive_toc": { "archive_toc": {
"title": "Archive table of contents", "title": "Table of contents for archive",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_toc", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_toc",
"type": "boolean", "type": "boolean",
"default": false "default": false
@ -287,7 +287,7 @@
"default": false "default": false
}, },
"categories_allowed": { "categories_allowed": {
"title": "Categories allowed", "title": "Allowed categories",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_allowed", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_allowed",
"type": "array", "type": "array",
"items": { "items": {
@ -309,11 +309,68 @@
"default": 10 "default": 10
}, },
"categories_toc": { "categories_toc": {
"title": "Categories table of contents", "title": "Table of contents for categories",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_toc", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_toc",
"type": "boolean", "type": "boolean",
"default": false "default": false
}, },
"authors": {
"title": "Author info",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors",
"type": "boolean",
"default": true
},
"authors_file": {
"title": "Authors file",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_file",
"type": "string",
"default": "\"{blog}/.authors.yml\""
},
"authors_profiles": {
"title": "Author profiles",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_profiles",
"type": "boolean",
"default": false
},
"authors_profiles_name": {
"title": "Authors profiles name",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_profiles_name",
"type": "string",
"default": "Authors"
},
"authors_profiles_url_format": {
"title": "Format string for author profile URLs",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_profiles_url_format",
"oneOf": [
{
"enum": [
"\"author/{slug}\"",
"\"{slug}\""
]
},
{
"type": "string"
}
]
},
"authors_profiles_pagination": {
"title": "Pagination for author profiles",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_profiles_pagination",
"type": "boolean",
"default": true
},
"authors_profiles_pagination_per_page": {
"title": "Posts per page for author profiles",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_profiles_pagination_per_page",
"type": "number",
"default": 10
},
"authors_profiles_toc": {
"title": "Table of contents for author profiles",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_profiles_toc",
"type": "boolean",
"default": false
},
"pagination": { "pagination": {
"title": "Pagination", "title": "Pagination",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.pagination", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.pagination",
@ -364,18 +421,6 @@
"type": "boolean", "type": "boolean",
"default": false "default": false
}, },
"authors": {
"title": "Author info",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors",
"type": "boolean",
"default": true
},
"authors_file": {
"title": "Authors file",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_file",
"type": "string",
"default": "\"{blog\\}/.authors.yml\""
},
"draft": { "draft": {
"title": "Render posts marked as drafts", "title": "Render posts marked as drafts",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.draft", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.draft",