Skip to content

Commit 7050abb

Browse files
committed
Documentation
1 parent 2d1d135 commit 7050abb

10 files changed

+325
-225
lines changed
28.4 KB
Loading
32.4 KB
Loading
32.8 KB
Loading
-13.8 KB
Loading

docs/getting-started.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@ install those packages separately.
6161

6262
:fontawesome-brands-youtube:{ style="color: #EE0F0F" }
6363
__[How to set up Material for MkDocs]__ by @james-willett – :octicons-clock-24:
64-
15m – Learn how to create and host a documentation site using Material for Docs
65-
on GitHub Pages in a step-by-step guide.
64+
15m – Learn how to create and host a documentation site using Material for
65+
MkDocs on GitHub Pages in a step-by-step guide.
6666

6767
[How to set up Material for MkDocs]: https://www.youtube.com/watch?v=Q-YA_dA8C20
6868

docs/insiders/changelog.md

+5
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
## Material for MkDocs Insiders
44

5+
### 4.33.0 <small>April 22, 2023</small> { id="4.33.0" }
6+
7+
- Added support for custom layouts for social plugin
8+
- Added support for background images for social cards
9+
510
### 4.32.6 <small>April 22, 2023</small> { id="4.32.6" }
611

712
- Fixed #5336: Interplay of blog plugin with git-revision-date-localized

docs/insiders/index.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -88,14 +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 25 additional features__ that you can start using right away, and
91+
access to 27 additional features__ that you can start using right away, and
9292
which are currently exclusively available to sponsors:
9393

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

96+
- [x] [Social plugin: custom layouts] :material-alert-decagram:{ .mdx-pulse title="Added on May 8, 2023" }
97+
- [x] [Social plugin: background images] :material-alert-decagram:{ .mdx-pulse title="Added on May 8, 2023" }
9698
- [x] [Code range selection] :material-alert-decagram:{ .mdx-pulse title="Added on February 19, 2023" }
97-
- [x] [Code annotations: custom selectors] :material-alert-decagram:{ .mdx-pulse title="Added on February 19, 2023" }
98-
- [x] [Privacy plugin: optimization support] :material-alert-decagram:{ .mdx-pulse title="Added on February 6, 2023" }
99+
- [x] [Code annotations: custom selectors]
100+
- [x] [Privacy plugin: optimization support]
99101
- [x] [Optimize plugin]
100102
- [x] [Navigation path] (Breadcrumbs)
101103
- [x] [Typeset plugin]
@@ -256,10 +258,6 @@ features prefixed with a checkmark symbol, denoting whether a feature is
256258
: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
257259
are released for general availability.
258260

259-
> [In February, we lost $1,3k in monthly funding because GitHub removed PayPal support][Twitter]
260-
261-
[Twitter]: https://twitter.com/squidfunk/status/1643539228574269443
262-
263261
#### $ 12,000 – Piri Piri
264262

265263
- [x] [Blog plugin]
@@ -327,10 +325,14 @@ are released for general availability.
327325

328326
#### $ 24,000 – Blockpaprika
329327

328+
- [x] [Social plugin: custom layouts]
329+
- [x] [Social plugin: background images]
330330
- [x] [Code range selection]
331331
- [x] [Code annotations: custom selectors]
332332
- [ ] Code line wrap button
333333

334+
[Social plugin: custom layouts]: ../setup/setting-up-social-cards.md#custom-layouts
335+
[Social plugin: background images]: ../setup/setting-up-social-cards.md#+social.cards_layout_params.background_image
334336
[Code range selection]: ../reference/code-blocks.md#code-selection-button
335337
[Code annotations: custom selectors]: ../reference/code-blocks.md#custom-selectors
336338

docs/setup/building-an-optimized-site.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
status: new
3-
---
4-
51
# Building an optimized site
62

73
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:
196192
``` yaml
197193
plugins:
198194
- optimize:
199-
cache_dir: path/to/folder
195+
cache_dir: .cache/plugins/optimize
200196
```
201197

202198
By default, all built-in plugins that implement caching will create a

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ The following configuration options are available:
9393
``` yaml
9494
plugins:
9595
- blog:
96-
blog_dir: path/to/folder
96+
blog_dir: blog
9797
```
9898

9999
=== "Standalone"

0 commit comments

Comments
 (0)