Skip to content

Commit 5e64e92

Browse files
committed
Merge branch 'master' into fix/instant-loading
2 parents 405dfce + 04b8d89 commit 5e64e92

File tree

148 files changed

+1279
-519
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

148 files changed

+1279
-519
lines changed

CHANGELOG

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,30 @@
1+
mkdocs-material-9.1.21+insiders-4.38.1 (2023-08-01)
2+
3+
* Improved nested serve mode for projects plugin
4+
* Improved compat in privacy plugin with third-party plugins
5+
* Fixed #5790: Typeset plugin ignores data-toc-label attribute
6+
* Fixed #5778: Interplay of privacy plugin with git-revision-date-localized
7+
* Fixed #5773: Info plugin erroring when community edition is in beta
8+
9+
mkdocs-material-9.1.21+insiders-4.38.0 (2023-07-29)
10+
11+
* Added projects plugin for building nested projects
12+
* Updated privacy plugin to new MkDocs API
13+
14+
mkdocs-material-9.1.21+insiders-4.37.1 (2023-07-28)
15+
16+
* Updated MkDocs to 1.5.1
17+
* Fixed deprecation warning in social plugin due to MkDocs upgrade
18+
* Fixed #5772: Privacy plugin fails due to API change in MkDocs
19+
20+
mkdocs-material-9.1.21 (2023-07-27)
21+
22+
* Fixed MkDocs 1.4 compat issue in social plugin (9.1.20 regression)
23+
24+
mkdocs-material-9.1.20 (2023-07-27)
25+
26+
* Fixed deprecation warnings for social plugin
27+
128
mkdocs-material-9.1.19 (2023-07-18)
229

330
* Added support for MkDocs 1.5+

docs/changelog/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22

33
## Material for MkDocs
44

5+
### 9.1.21 <small>July 27, 2023</small> { id="9.1.20" }
6+
7+
- Fixed MkDocs 1.4 compat issue in social plugin (9.1.20 regression)
8+
9+
### 9.1.20 <small>July 27, 2023</small> { id="9.1.20" }
10+
11+
- Updated Sanskrit translations
12+
- Fixed deprecation warnings for social plugin
13+
514
### 9.1.19 <small>July 18, 2023</small> { id="9.1.19" }
615

716
- Added support for MkDocs 1.5+

docs/getting-started.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -123,16 +123,31 @@ The following plugins are bundled with the Docker image:
123123
??? question "How to add plugins to the Docker image?"
124124

125125
Material for MkDocs only bundles selected plugins in order to keep the size
126-
of the official image small. If the plugin you want to use is not included,
127-
create a `user-requirements.txt` file in the repository root with the packages
128-
you want to install additionally, e.g.:
126+
of the official image small. If the plugin you want to use is not included,
127+
you can add them easily:
129128

130-
``` txt title="user-requirements.txt"
131-
mkdocs-macros-plugin==0.7.0
132-
mkdocs-glightbox>=0.3.1
133-
```
129+
=== "Material for MkDocs"
130+
131+
Create a `Dockerfile` and extend the official image:
132+
133+
``` Dockerfile title="Dockerfile"
134+
FROM squidfunk/mkdocs-material
135+
RUN pip install mkdocs-macros-plugin
136+
RUN pip install mkdocs-glightbox
137+
```
138+
139+
=== "Insiders"
140+
141+
Clone or fork the Insiders repository, and create a file called
142+
`user-requirements.txt` in the root of the repository. Then, add the
143+
plugins that should be installed to the file, e.g.:
144+
145+
``` txt title="user-requirements.txt"
146+
mkdocs-macros-plugin
147+
mkdocs-glightbox
148+
```
134149

135-
Next, you can build the image with the following command:
150+
Next, build the image with the following command:
136151

137152
```
138153
docker build -t squidfunk/mkdocs-material .

docs/guides/creating-a-reproduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ inside it. Next:
9393
non-essential lines and files.
9494
9595
[bug reporting guide]: ../contributing/reporting-a-bug.md#upgrade-to-latest-version
96-
[minimal configuration]: ../../creating-your-site/#minimal-configuration
96+
[minimal configuration]: ../creating-your-site.md#minimal-configuration
9797
9898
### Creating a .zip file
9999

docs/insiders/changelog.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,25 @@
22

33
## Material for MkDocs Insiders
44

5+
### 4.38.1 <small>August 1, 2023</small> { id="4.38.1" }
6+
7+
- Improved nested serve mode for projects plugin
8+
- Improved compat in privacy plugin with third-party plugins
9+
- Fixed #5790: Typeset plugin ignores data-toc-label attribute
10+
- Fixed #5778: Interplay of privacy plugin with git-revision-date-localized
11+
- Fixed #5773: Info plugin erroring when community edition is in beta
12+
13+
### 4.38.0 <small>July 29, 2023</small> { id="4.38.0" }
14+
15+
- Added projects plugin for building nested projects
16+
- Updated privacy plugin to new MkDocs API
17+
18+
### 4.37.1 <small>July 28, 2023</small> { id="4.37.1" }
19+
20+
- Updated MkDocs to 1.5.1
21+
- Fixed deprecation warning in social plugin due to MkDocs upgrade
22+
- Fixed #5772: Privacy plugin fails due to API change in MkDocs
23+
524
### 4.37.0 <small>July 7, 2023</small> { id="4.37.0" }
625

726
- Added support for overriding social cards settings per page

docs/insiders/index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,11 +88,12 @@ 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 22 additional features__ that you can __start using now__, and
91+
access to 23 additional features__ that you can __start using now__, and
9292
which are currently exclusively available to sponsors:
9393

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

96+
- [x] [Projects plugin] :material-alert-decagram:{ .mdx-pulse title="Added on July 29, 2023" }
9697
- [x] [Instant prefetching] :material-alert-decagram:{ .mdx-pulse title="Added on June 15, 2023" }
9798
- [x] [Social plugin: custom layouts] :material-alert-decagram:{ .mdx-pulse title="Added on May 8, 2023" }
9899
- [x] [Social plugin: background images] :material-alert-decagram:{ .mdx-pulse title="Added on May 8, 2023" }
@@ -311,12 +312,14 @@ are released for general availability.
311312

312313
#### $ 24,000 – Blockpaprika
313314

315+
- [x] [Projects plugin]
314316
- [x] [Social plugin: custom layouts]
315317
- [x] [Social plugin: background images]
316318
- [x] [Code range selection]
317319
- [x] [Code annotations: custom selectors]
318320
- [ ] Code line wrap button
319321

322+
[Projects plugin]: ../setup/building-an-optimized-site.md#built-in-projects-plugin
320323
[Social plugin: custom layouts]: ../setup/setting-up-social-cards.md#customization
321324
[Social plugin: background images]: ../setup/setting-up-social-cards.md#+social.cards_layout_params.background_image
322325
[Code range selection]: ../reference/code-blocks.md#code-selection-button

docs/reference/code-blocks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ theme:
162162
[Code annotations support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.0.0
163163
[Attribute Lists]: ../setup/extensions/python-markdown.md#attribute-lists
164164

165-
#### Custom selectors :material-alert-decagram:{ .mdx-pulse title="Added on February 19, 2023" }
165+
#### Custom selectors
166166

167167
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
168168
[:octicons-tag-24: insiders-4.32.0][Insiders] ·

0 commit comments

Comments
 (0)