Documentation

squidfunk · May 8, 2023 · 7050abb · 7050abb
1 parent 2d1d135
commit 7050abb
Show file tree

Hide file tree

Showing 10 changed files with 325 additions and 225 deletions.
diff --git a/docs/assets/screenshots/social-cards-accent.png b/docs/assets/screenshots/social-cards-accent.png
diff --git a/docs/assets/screenshots/social-cards-invert.png b/docs/assets/screenshots/social-cards-invert.png
diff --git a/docs/assets/screenshots/social-cards-variant.png b/docs/assets/screenshots/social-cards-variant.png
diff --git a/docs/assets/screenshots/social-cards.png b/docs/assets/screenshots/social-cards.png
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -61,8 +61,8 @@ install those packages separately.
 
 :fontawesome-brands-youtube:{ style="color: #EE0F0F" }
 __[How to set up Material for MkDocs]__ by @james-willett – :octicons-clock-24:
-15m – Learn how to create and host a documentation site using Material for Docs
-on GitHub Pages in a step-by-step guide.
+15m – Learn how to create and host a documentation site using Material for 
+MkDocs on GitHub Pages in a step-by-step guide.
 
   [How to set up Material for MkDocs]: https://www.youtube.com/watch?v=Q-YA_dA8C20
 

diff --git a/docs/insiders/changelog.md b/docs/insiders/changelog.md
@@ -2,6 +2,11 @@
 
 ## Material for MkDocs Insiders
 
+### 4.33.0 <small>April 22, 2023</small> { id="4.33.0" }
+
+- Added support for custom layouts for social plugin
+- Added support for background images for social cards
+
 ### 4.32.6 <small>April 22, 2023</small> { id="4.32.6" }
 
 - Fixed #5336: Interplay of blog plugin with git-revision-date-localized

diff --git a/docs/insiders/index.md b/docs/insiders/index.md
@@ -88,14 +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 25 additional features__ that you can start using right away, and
+access to 27 additional features__ that you can start using right away, and
 which are currently exclusively available to sponsors:
 
 <div class="mdx-columns" markdown>
 
+- [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] [Code range selection] :material-alert-decagram:{ .mdx-pulse title="Added on February 19, 2023" }
-- [x] [Code annotations: custom selectors] :material-alert-decagram:{ .mdx-pulse title="Added on February 19, 2023" }
-- [x] [Privacy plugin: optimization support] :material-alert-decagram:{ .mdx-pulse title="Added on February 6, 2023" }
+- [x] [Code annotations: custom selectors]
+- [x] [Privacy plugin: optimization support]
 - [x] [Optimize plugin]
 - [x] [Navigation path] (Breadcrumbs)
 - [x] [Typeset plugin]
@@ -256,10 +258,6 @@ features prefixed with a checkmark symbol, denoting whether a feature is
 :octicons-check-circle-fill-24:{ style="color: var(--md-default-fg-color--lightest)" } planned, but not yet implemented. When the funding goal is hit, the features
 are released for general availability.
 
-> [In February, we lost $1,3k in monthly funding because GitHub removed PayPal support][Twitter]
-
-  [Twitter]: https://twitter.com/squidfunk/status/1643539228574269443
-
 #### $ 12,000 – Piri Piri
 
 - [x] [Blog plugin]
@@ -327,10 +325,14 @@ are released for general availability.
 
 #### $ 24,000 – Blockpaprika
 
+- [x] [Social plugin: custom layouts]
+- [x] [Social plugin: background images]
 - [x] [Code range selection]
 - [x] [Code annotations: custom selectors]
 - [ ] Code line wrap button
 
+  [Social plugin: custom layouts]: ../setup/setting-up-social-cards.md#custom-layouts
+  [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
 

diff --git a/docs/setup/building-an-optimized-site.md b/docs/setup/building-an-optimized-site.md
@@ -1,7 +1,3 @@
----
-status: new
----
-
 # Building an optimized site
 
 Material for MkDocs, by default, allows to build optimized sites that rank great
@@ -196,7 +192,7 @@ The following configuration options are available for caching:
     ``` yaml
     plugins:
       - optimize:
-          cache_dir: path/to/folder
+          cache_dir: .cache/plugins/optimize
     ```
 
     By default, all built-in plugins that implement caching will create a

diff --git a/docs/setup/setting-up-a-blog.md b/docs/setup/setting-up-a-blog.md
@@ -93,7 +93,7 @@ The following configuration options are available:
         ``` yaml
         plugins:
           - blog:
-              blog_dir: path/to/folder
+              blog_dir: blog
         ```
 
     === "Standalone"