Skip to content

Commit 0fd2a39

Browse files
committed
Added documentation on new advanced blog settings
1 parent a6772cf commit 0fd2a39

File tree

3 files changed

+27
-8
lines changed

3 files changed

+27
-8
lines changed

docs/insiders/index.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,15 +88,16 @@ a handful of them, [thanks to our awesome sponsors]!
8888
## What's in it for me?
8989

9090
The moment you [become a sponsor][how to become a sponsor], you'll get __immediate
91-
access to 23 additional features__ that you can __start using now__, and
91+
access to 24 additional features__ that you can __start using now__, and
9292
which are currently exclusively available to sponsors:
9393

9494
<div class="mdx-columns" markdown>
9595

96+
- [x] [Blog plugin: advanced settings] :material-alert-decagram:{ .mdx-pulse title="Added on November 23, 2023" }
9697
- [x] [Projects plugin] :material-alert-decagram:{ .mdx-pulse title="Added on July 29, 2023" }
9798
- [x] [Instant prefetching] :material-alert-decagram:{ .mdx-pulse title="Added on June 15, 2023" }
98-
- [x] [Social plugin: custom layouts] :material-alert-decagram:{ .mdx-pulse title="Added on May 8, 2023" }
99-
- [x] [Social plugin: background images] :material-alert-decagram:{ .mdx-pulse title="Added on May 8, 2023" }
99+
- [x] [Social plugin: custom layouts]
100+
- [x] [Social plugin: background images]
100101
- [x] [Code range selection]
101102
- [x] [Code annotations: custom selectors]
102103
- [x] [Privacy plugin: optimization support]
@@ -324,13 +325,14 @@ are released for general availability.
324325
- [x] [Social plugin: background images]
325326
- [x] [Code range selection]
326327
- [x] [Code annotations: custom selectors]
327-
- [ ] Code line wrap button
328+
- [x] [Blog plugin: advanced settings]
328329

329330
[Projects plugin]: ../plugins/projects.md
330331
[Social plugin: custom layouts]: ../setup/setting-up-social-cards.md#customization
331332
[Social plugin: background images]: ../setup/setting-up-social-cards.md#+social.cards_layout_params.background_image
332333
[Code range selection]: ../reference/code-blocks.md#code-selection-button
333334
[Code annotations: custom selectors]: ../reference/code-blocks.md#custom-selectors
335+
[Blog plugin: advanced settings]: ../setup/setting-up-a-blog.md#advanced-settings
334336

335337
### Goals completed
336338

docs/setup/setting-up-a-blog.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,22 @@ plugins:
3434
3535
For a list of all settings, please consult the [plugin documentation].
3636
37+
#### Advanced settings :material-alert-decagram:{ .mdx-pulse title="Added on November 23, 2023" }
38+
39+
<!-- md:sponsors -->
40+
<!-- md:version insiders-4.44.0 -->
41+
42+
The following advanced settings are currently reserved to our [sponsors]
43+
[Insiders]. They are entirely optional, and don't affect the functionality of
44+
the blog, but can be helpful for customizations:
45+
46+
- [`archive_pagination`][config.archive_pagination]
47+
- [`archive_pagination_per_page`][config.archive_pagination_per_page]
48+
- [`categories_pagination`][config.categories_pagination]
49+
- [`categories_pagination_per_page`][config.categories_pagination_per_page]
50+
51+
We'll add more settings here, as we discover new use cases.
52+
3753
[plugin documentation]: ../plugins/blog.md
3854

3955
[Insiders]: ../insiders/index.md
@@ -42,6 +58,11 @@ For a list of all settings, please consult the [plugin documentation].
4258
[docs_dir]: https://www.mkdocs.org/user-guide/configuration/#docs_dir
4359
[start writing your first post]: #writing-your-first-post
4460

61+
[config.archive_pagination]: ../plugins/blog.md#config.archive_pagination
62+
[config.archive_pagination_per_page]: ../plugins/blog.md#config.archive_pagination_per_page
63+
[config.categories_pagination]: ../plugins/blog.md#config.categories_pagination
64+
[config.categories_pagination_per_page]: ../plugins/blog.md#config.categories_pagination_per_page
65+
4566
### RSS
4667

4768
<!-- md:version 9.2.0 -->

docs/setup/setting-up-social-cards.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
status: new
3-
---
4-
51
# Setting up social cards
62

73
Material for MkDocs can automatically create beautiful social cards for your

0 commit comments

Comments
 (0)