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

Added documentation on new advanced blog settings

Browse Source
This commit is contained in:
squidfunk 2023-11-23 11:41:19 +01:00
parent a6772cf5e8
commit 0fd2a3940e
No known key found for this signature in database
GPG Key ID: 5ED40BC4F9C436DF
3 changed files with 27 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/insiders/index.md
View File

@ -88,15 +88,16 @@ a handful of them, [thanks to our awesome sponsors]!
## What's in it for me? ## What's in it for me?
The moment you [become a sponsor][how to become a sponsor], you'll get __immediate 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: which are currently exclusively available to sponsors:
<div class="mdx-columns" markdown> <div class="mdx-columns" markdown>
- [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] [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] [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: custom layouts]
- [x] [Social plugin: background images] :material-alert-decagram:{ .mdx-pulse title="Added on May 8, 2023" } - [x] [Social plugin: background images]
- [x] [Code range selection] - [x] [Code range selection]
- [x] [Code annotations: custom selectors] - [x] [Code annotations: custom selectors]
- [x] [Privacy plugin: optimization support] - [x] [Privacy plugin: optimization support]
@ -324,13 +325,14 @@ are released for general availability.
- [x] [Social plugin: background images] - [x] [Social plugin: background images]
- [x] [Code range selection] - [x] [Code range selection]
- [x] [Code annotations: custom selectors] - [x] [Code annotations: custom selectors]
- [ ] Code line wrap button - [x] [Blog plugin: advanced settings]
[Projects plugin]: ../plugins/projects.md [Projects plugin]: ../plugins/projects.md
[Social plugin: custom layouts]: ../setup/setting-up-social-cards.md#customization [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 [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 range selection]: ../reference/code-blocks.md#code-selection-button
[Code annotations: custom selectors]: ../reference/code-blocks.md#custom-selectors [Code annotations: custom selectors]: ../reference/code-blocks.md#custom-selectors
[Blog plugin: advanced settings]: ../setup/setting-up-a-blog.md#advanced-settings
### Goals completed ### Goals completed

21
docs/setup/setting-up-a-blog.md
View File

@ -34,6 +34,22 @@ plugins:
For a list of all settings, please consult the [plugin documentation]. For a list of all settings, please consult the [plugin documentation].
#### Advanced settings :material-alert-decagram:{ .mdx-pulse title="Added on November 23, 2023" }
<!-- md:sponsors -->
<!-- md:version insiders-4.44.0 -->
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 [plugin documentation]: ../plugins/blog.md
[Insiders]: ../insiders/index.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 [docs_dir]: https://www.mkdocs.org/user-guide/configuration/#docs_dir
[start writing your first post]: #writing-your-first-post [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 ### RSS
<!-- md:version 9.2.0 --> <!-- md:version 9.2.0 -->

4
docs/setup/setting-up-social-cards.md
View File

@ -1,7 +1,3 @@
---
status: new
---
# Setting up social cards # Setting up social cards
Material for MkDocs can automatically create beautiful social cards for your Material for MkDocs can automatically create beautiful social cards for your