Added documentation on new advanced blog settings

This commit is contained in:
squidfunk 2023-11-23 11:26:05 +01:00
parent 120a9be634
commit a6772cf5e8
No known key found for this signature in database
GPG Key ID: 5ED40BC4F9C436DF
2 changed files with 98 additions and 2 deletions

View File

@ -731,6 +731,42 @@ The following placeholders are available:
--- ---
#### <!-- md:setting config.archive_pagination -->
<!-- md:sponsors -->
<!-- md:version insiders-4.44.0 -->
<!-- md:default `true` -->
Use this setting to enable or disable pagination for archive pages. The value
of this setting is inherited from [`pagination`][config.pagination], unless it's
explicitly set. To disable pagination, use:
``` yaml
plugins:
- blog:
archive_pagination: false
```
---
#### <!-- md:setting config.archive_pagination_per_page -->
<!-- md:sponsors -->
<!-- md:version insiders-4.44.0 -->
<!-- md:default `10` -->
Use this setting to change the number of posts rendered per archive page. The
value of this setting is inherited from [`pagination_per_page`]
[config.pagination_per_page], unless it's explicitly set:
``` yaml
plugins:
- blog:
archive_pagination_per_page: 5
```
---
#### <!-- md:setting config.archive_toc --> #### <!-- md:setting config.archive_toc -->
<!-- md:version 9.2.0 --> <!-- md:version 9.2.0 -->
@ -738,7 +774,7 @@ The following placeholders are available:
Use this setting to leverage the table of contents to display post titles on all Use this setting to leverage the table of contents to display post titles on all
archive pages. The value of this setting is inherited from [`blog_toc`] archive pages. The value of this setting is inherited from [`blog_toc`]
[config.blog_toc], unless its explicitly set: [config.blog_toc], unless it's explicitly set:
``` yaml ``` yaml
plugins: plugins:
@ -888,6 +924,42 @@ this list. Posts can be assigned to categories by using the [`categories`]
--- ---
#### <!-- md:setting config.categories_pagination -->
<!-- md:sponsors -->
<!-- md:version insiders-4.44.0 -->
<!-- md:default `true` -->
Use this setting to enable or disable pagination for category pages. The value
of this setting is inherited from [`pagination`][config.pagination], unless it's
explicitly set. To disable pagination, use:
``` yaml
plugins:
- blog:
categories_pagination: false
```
---
#### <!-- md:setting config.categories_pagination_per_page -->
<!-- md:sponsors -->
<!-- md:version insiders-4.44.0 -->
<!-- md:default `10` -->
Use this setting to change the number of posts rendered per category page. The
value of this setting is inherited from [`pagination_per_page`]
[config.pagination_per_page], unless it's explicitly set:
``` yaml
plugins:
- blog:
categories_pagination_per_page: 5
```
---
#### <!-- md:setting config.categories_toc --> #### <!-- md:setting config.categories_toc -->
<!-- md:version 9.2.0 --> <!-- md:version 9.2.0 -->
@ -895,7 +967,7 @@ this list. Posts can be assigned to categories by using the [`categories`]
Use this setting to leverage the table of contents to display post titles on all Use this setting to leverage the table of contents to display post titles on all
category pages. The value of this setting is inherited from [`blog_toc`] category pages. The value of this setting is inherited from [`blog_toc`]
[config.blog_toc], unless its explicitly set: [config.blog_toc], unless it's explicitly set:
``` yaml ``` yaml
plugins: plugins:

View File

@ -209,6 +209,18 @@
} }
] ]
}, },
"archive_pagination": {
"title": "Pagination for archive pages",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_pagination",
"type": "boolean",
"default": true
},
"archive_pagination_per_page": {
"title": "Posts per page for archive pages",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_pagination_per_page",
"type": "number",
"default": 10
},
"archive_toc": { "archive_toc": {
"title": "Archive table of contents", "title": "Archive table of contents",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_toc", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_toc",
@ -263,6 +275,18 @@
"uniqueItems": true, "uniqueItems": true,
"default": [] "default": []
}, },
"categories_pagination": {
"title": "Pagination for categories",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_pagination",
"type": "boolean",
"default": true
},
"categories_pagination_per_page": {
"title": "Posts per page for categories",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_pagination_per_page",
"type": "number",
"default": 10
},
"categories_toc": { "categories_toc": {
"title": "Categories table of contents", "title": "Categories table of contents",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_toc", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_toc",