Skip to content

Commit

Permalink
Added documentation on new advanced blog settings
Browse files Browse the repository at this point in the history
  • Loading branch information
squidfunk committed Nov 23, 2023
1 parent a6772cf commit 0fd2a39
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 8 deletions.
10 changes: 6 additions & 4 deletions docs/insiders/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

<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] [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]
Expand Down Expand Up @@ -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

Expand Down
21 changes: 21 additions & 0 deletions docs/setup/setting-up-a-blog.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" }
<!-- 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

[Insiders]: ../insiders/index.md
Expand All @@ -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

<!-- md:version 9.2.0 -->
Expand Down
4 changes: 0 additions & 4 deletions docs/setup/setting-up-social-cards.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
status: new
---

# Setting up social cards

Material for MkDocs can automatically create beautiful social cards for your
Expand Down

0 comments on commit 0fd2a39

Please sign in to comment.