From 0fd2a3940e9f0781c5568c9d8bd23ac54e66fb8e Mon Sep 17 00:00:00 2001 From: squidfunk Date: Thu, 23 Nov 2023 11:41:19 +0100 Subject: [PATCH] Added documentation on new advanced blog settings --- docs/insiders/index.md | 10 ++++++---- docs/setup/setting-up-a-blog.md | 21 +++++++++++++++++++++ docs/setup/setting-up-social-cards.md | 4 ---- 3 files changed, 27 insertions(+), 8 deletions(-) diff --git a/docs/insiders/index.md b/docs/insiders/index.md index 380a2b4326e..3b7123fd424 100644 --- a/docs/insiders/index.md +++ b/docs/insiders/index.md @@ -88,15 +88,16 @@ a handful of them, [thanks to our awesome sponsors]! ## What's in it for me? The moment you [become a sponsor][how to become a sponsor], you'll get __immediate -access to 23 additional features__ that you can __start using now__, and +access to 24 additional features__ that you can __start using now__, and which are currently exclusively available to sponsors:
+- [x] [Blog plugin: advanced settings] :material-alert-decagram:{ .mdx-pulse title="Added on November 23, 2023" } - [x] [Projects plugin] :material-alert-decagram:{ .mdx-pulse title="Added on July 29, 2023" } - [x] [Instant prefetching] :material-alert-decagram:{ .mdx-pulse title="Added on June 15, 2023" } -- [x] [Social plugin: custom layouts] :material-alert-decagram:{ .mdx-pulse title="Added on May 8, 2023" } -- [x] [Social plugin: background images] :material-alert-decagram:{ .mdx-pulse title="Added on May 8, 2023" } +- [x] [Social plugin: custom layouts] +- [x] [Social plugin: background images] - [x] [Code range selection] - [x] [Code annotations: custom selectors] - [x] [Privacy plugin: optimization support] @@ -324,13 +325,14 @@ are released for general availability. - [x] [Social plugin: background images] - [x] [Code range selection] - [x] [Code annotations: custom selectors] -- [ ] Code line wrap button +- [x] [Blog plugin: advanced settings] [Projects plugin]: ../plugins/projects.md [Social plugin: custom layouts]: ../setup/setting-up-social-cards.md#customization [Social plugin: background images]: ../setup/setting-up-social-cards.md#+social.cards_layout_params.background_image [Code range selection]: ../reference/code-blocks.md#code-selection-button [Code annotations: custom selectors]: ../reference/code-blocks.md#custom-selectors + [Blog plugin: advanced settings]: ../setup/setting-up-a-blog.md#advanced-settings ### Goals completed diff --git a/docs/setup/setting-up-a-blog.md b/docs/setup/setting-up-a-blog.md index e01593a8771..d76326d5c59 100644 --- a/docs/setup/setting-up-a-blog.md +++ b/docs/setup/setting-up-a-blog.md @@ -34,6 +34,22 @@ plugins: For a list of all settings, please consult the [plugin documentation]. +#### Advanced settings :material-alert-decagram:{ .mdx-pulse title="Added on November 23, 2023" } + + + + +The following advanced settings are currently reserved to our [sponsors] +[Insiders]. They are entirely optional, and don't affect the functionality of +the blog, but can be helpful for customizations: + +- [`archive_pagination`][config.archive_pagination] +- [`archive_pagination_per_page`][config.archive_pagination_per_page] +- [`categories_pagination`][config.categories_pagination] +- [`categories_pagination_per_page`][config.categories_pagination_per_page] + +We'll add more settings here, as we discover new use cases. + [plugin documentation]: ../plugins/blog.md [Insiders]: ../insiders/index.md @@ -42,6 +58,11 @@ For a list of all settings, please consult the [plugin documentation]. [docs_dir]: https://www.mkdocs.org/user-guide/configuration/#docs_dir [start writing your first post]: #writing-your-first-post + [config.archive_pagination]: ../plugins/blog.md#config.archive_pagination + [config.archive_pagination_per_page]: ../plugins/blog.md#config.archive_pagination_per_page + [config.categories_pagination]: ../plugins/blog.md#config.categories_pagination + [config.categories_pagination_per_page]: ../plugins/blog.md#config.categories_pagination_per_page + ### RSS diff --git a/docs/setup/setting-up-social-cards.md b/docs/setup/setting-up-social-cards.md index 646af5f2ce8..b326f6482a3 100644 --- a/docs/setup/setting-up-social-cards.md +++ b/docs/setup/setting-up-social-cards.md @@ -1,7 +1,3 @@ ---- -status: new ---- - # Setting up social cards Material for MkDocs can automatically create beautiful social cards for your