Skip to content

Commit c81befb

Browse files
committed
Updated JSON schema
1 parent 6be485c commit c81befb

File tree

1 file changed

+64
-19
lines changed

1 file changed

+64
-19
lines changed

docs/schema/plugins/blog.json

Lines changed: 64 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@
2626
"default": "blog"
2727
},
2828
"blog_toc": {
29-
"title": "Blog table of contents",
29+
"title": "Table of contents",
3030
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.blog_toc",
3131
"type": "boolean",
3232
"default": false
3333
},
3434
"post_dir": {
35-
"title": "Blog posts directory",
35+
"title": "Post directory",
3636
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_dir",
3737
"type": "string",
3838
"default": "\"{blog\\}/posts\""
@@ -210,19 +210,19 @@
210210
]
211211
},
212212
"archive_pagination": {
213-
"title": "Pagination for archive pages",
213+
"title": "Pagination for archive",
214214
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_pagination",
215215
"type": "boolean",
216216
"default": true
217217
},
218218
"archive_pagination_per_page": {
219-
"title": "Posts per page for archive pages",
219+
"title": "Posts per page for archive",
220220
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_pagination_per_page",
221221
"type": "number",
222222
"default": 10
223223
},
224224
"archive_toc": {
225-
"title": "Archive table of contents",
225+
"title": "Table of contents for archive",
226226
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_toc",
227227
"type": "boolean",
228228
"default": false
@@ -287,7 +287,7 @@
287287
"default": false
288288
},
289289
"categories_allowed": {
290-
"title": "Categories allowed",
290+
"title": "Allowed categories",
291291
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_allowed",
292292
"type": "array",
293293
"items": {
@@ -309,11 +309,68 @@
309309
"default": 10
310310
},
311311
"categories_toc": {
312-
"title": "Categories table of contents",
312+
"title": "Table of contents for categories",
313313
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_toc",
314314
"type": "boolean",
315315
"default": false
316316
},
317+
"authors": {
318+
"title": "Author info",
319+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors",
320+
"type": "boolean",
321+
"default": true
322+
},
323+
"authors_file": {
324+
"title": "Authors file",
325+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_file",
326+
"type": "string",
327+
"default": "\"{blog}/.authors.yml\""
328+
},
329+
"authors_profiles": {
330+
"title": "Author profiles",
331+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_profiles",
332+
"type": "boolean",
333+
"default": false
334+
},
335+
"authors_profiles_name": {
336+
"title": "Authors profiles name",
337+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_profiles_name",
338+
"type": "string",
339+
"default": "Authors"
340+
},
341+
"authors_profiles_url_format": {
342+
"title": "Format string for author profile URLs",
343+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_profiles_url_format",
344+
"oneOf": [
345+
{
346+
"enum": [
347+
"\"author/{slug}\"",
348+
"\"{slug}\""
349+
]
350+
},
351+
{
352+
"type": "string"
353+
}
354+
]
355+
},
356+
"authors_profiles_pagination": {
357+
"title": "Pagination for author profiles",
358+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_profiles_pagination",
359+
"type": "boolean",
360+
"default": true
361+
},
362+
"authors_profiles_pagination_per_page": {
363+
"title": "Posts per page for author profiles",
364+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_profiles_pagination_per_page",
365+
"type": "number",
366+
"default": 10
367+
},
368+
"authors_profiles_toc": {
369+
"title": "Table of contents for author profiles",
370+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_profiles_toc",
371+
"type": "boolean",
372+
"default": false
373+
},
317374
"pagination": {
318375
"title": "Pagination",
319376
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.pagination",
@@ -364,18 +421,6 @@
364421
"type": "boolean",
365422
"default": false
366423
},
367-
"authors": {
368-
"title": "Author info",
369-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors",
370-
"type": "boolean",
371-
"default": true
372-
},
373-
"authors_file": {
374-
"title": "Authors file",
375-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_file",
376-
"type": "string",
377-
"default": "\"{blog\\}/.authors.yml\""
378-
},
379424
"draft": {
380425
"title": "Render posts marked as drafts",
381426
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.draft",

0 commit comments

Comments
 (0)