mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-11-12 01:50:52 +01:00
Updated Insiders changelog
This commit is contained in:
parent
5c67b731d8
commit
c4e78567da
@ -1,3 +1,9 @@
|
||||
mkdocs-material-9.0.11+insiders-4.30.0 (2023-02-06)
|
||||
|
||||
* Rewrite of privacy plugin for concurrency, now twice as fast
|
||||
* Added support for explicit inclusion for privacy plugin
|
||||
* Added optimization support for privacy plugin (+ optimize plugin)
|
||||
|
||||
mkdocs-material-9.0.11 (2023-02-03)
|
||||
|
||||
* Added Mastodon verification for social links (rel=me)
|
||||
|
@ -2,6 +2,12 @@
|
||||
|
||||
## Material for MkDocs Insiders
|
||||
|
||||
### 4.30.0 <small>February 6, 2023</small> { id="4.30.0" }
|
||||
|
||||
- Rewrite of privacy plugin for concurrency, now twice as fast
|
||||
- Added support for explicit inclusion for privacy plugin
|
||||
- Added optimization support for privacy plugin (+ optimize plugin)
|
||||
|
||||
### 4.29.0 <small>January 21, 2023</small> { id="4.29.0" }
|
||||
|
||||
- Added built-in optimize plugin for automatically compressing images
|
||||
|
@ -88,14 +88,15 @@ 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 22 additional features__ that you can start using right away, and
|
||||
access to 23 additional features__ that you can start using right away, and
|
||||
which are currently exclusively available to sponsors:
|
||||
|
||||
<div class="mdx-columns" markdown>
|
||||
|
||||
- [x] [Privacy plugin: optimization support] :material-alert-decagram:{ .mdx-pulse title="Added on February 6, 2023" }
|
||||
- [x] [Optimize plugin] :material-alert-decagram:{ .mdx-pulse title="Added on January 21, 2023" }
|
||||
- [x] [Navigation path] (Breadcrumbs) :material-alert-decagram:{ .mdx-pulse title="Added on January 14, 2023" }
|
||||
- [x] [Typeset plugin] :material-alert-decagram:{ .mdx-pulse title="Added on December 20, 2022" }
|
||||
- [x] [Typeset plugin]
|
||||
- [x] [Privacy plugin: external links]
|
||||
- [x] [Navigation subtitles]
|
||||
- [x] [Tags plugin: allow list] + [custom sorting]
|
||||
@ -305,12 +306,13 @@ are released for general availability.
|
||||
- [x] [Typeset plugin]
|
||||
- [x] [Privacy plugin: external links]
|
||||
- [x] [Navigation path] (Breadcrumbs)
|
||||
- [ ] Privacy plugin: optimization support
|
||||
- [x] [Privacy plugin: optimization support]
|
||||
- [ ] Code block line wrapping
|
||||
|
||||
[Optimize plugin]: ../setup/building-an-optimized-site.md#built-in-optimize-plugin
|
||||
[Typeset plugin]: ../reference/index.md#built-in-typeset-plugin
|
||||
[Privacy plugin: external links]: ../setup/ensuring-data-privacy.md#+privacy.external_links
|
||||
[Privacy plugin: optimization support]: ../setup/ensuring-data-privacy.md#+privacy.external_assets_include
|
||||
[Navigation path]: ../setup/setting-up-navigation.md#navigation-path
|
||||
[Instant previews]: https://twitter.com/squidfunk/status/1466794654213492743
|
||||
|
||||
|
@ -7,7 +7,7 @@ within Markdown files.
|
||||
|
||||
## Configuration
|
||||
|
||||
### Built-in <u>typeset</u> plugin :material-alert-decagram:{ .mdx-pulse title="Added on December 20, 2022" }
|
||||
### Built-in <u>typeset</u> plugin
|
||||
|
||||
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
|
||||
[:octicons-tag-24: insiders-4.27.0][Insiders] ·
|
||||
|
@ -179,6 +179,19 @@ The following configuration options are available:
|
||||
enabled: !ENV [CI, false]
|
||||
```
|
||||
|
||||
[`concurrency`](#+privacy.concurrency){ #+privacy.concurrency } :material-alert-decagram:{ .mdx-pulse title="Added on February 6, 2023" }
|
||||
|
||||
: :octicons-milestone-24: Default: _number of CPUs_ – This option specifies
|
||||
how many CPUs the plugin is allowed to use when downloading external assets.
|
||||
With more CPUs, the plugin can do more work in the same time, thus complete
|
||||
its work faster. Concurrent processing can be disabled with:
|
||||
|
||||
``` yaml
|
||||
plugins:
|
||||
- privacy:
|
||||
concurrency: 1
|
||||
```
|
||||
|
||||
[Insiders]: ../insiders/index.md
|
||||
[built-in plugins]: ../insiders/getting-started.md#built-in-plugins
|
||||
|
||||
@ -221,6 +234,37 @@ The following configuration options are available for external assets:
|
||||
|
||||
The path must be defined relative to [`docs_dir`][docs_dir].
|
||||
|
||||
[`external_assets_include`](#+privacy.external_assets_include){ #+privacy.external_assets_include } :material-alert-decagram:{ .mdx-pulse title="Added on February 6, 2023" }
|
||||
|
||||
: :octicons-milestone-24: Default: _none_ – This option allows to only include
|
||||
certain external assets for processing by the privacy plugin, so they will
|
||||
be downloaded and bundled during the build:
|
||||
|
||||
``` yaml
|
||||
plugins:
|
||||
- privacy:
|
||||
external_assets_include:
|
||||
- unsplash.com/*
|
||||
```
|
||||
|
||||
!!! tip "Hosting images externally and optimizing them automatically"
|
||||
|
||||
This option makes the [built-in privacy plugin] an excellent choice for
|
||||
when you want to host assets like images outside of your git repository
|
||||
in another location to keep them fresh and your repository lean.
|
||||
|
||||
Additionally, as of [:octicons-tag-24: insiders-4.30.0][Insiders], the
|
||||
built-in privacy plugin was entirely rewritten and now works perfectly
|
||||
with the [built-in optimize plugin], which means that external assets
|
||||
can be passed through the same optimization pipeline as the rest of your
|
||||
documentation. This means you can store and edit unoptimized files
|
||||
outside of your repository, and let both plugins built a highly
|
||||
optimized site for you.
|
||||
|
||||
If you want to implement separate pipelines, i.e., optimize some images
|
||||
differently from others or exclude some images from downloading, you can
|
||||
use multiple instances of the [built-in privacy plugin].
|
||||
|
||||
[`external_assets_exclude`](#+privacy.external_assets_exclude){ #+privacy.external_assets_exclude }
|
||||
|
||||
: :octicons-milestone-24: Default: _none_ – This option allows to exclude
|
||||
@ -279,6 +323,7 @@ The following configuration options are available for external assets:
|
||||
[regular font]: changing-the-fonts.md#regular-font
|
||||
[example]: #example
|
||||
[technical limitations]: #limitations
|
||||
[built-in optimize plugin]: building-an-optimized-site.md#built-in-optimize-plugin
|
||||
|
||||
#### External links :material-alert-decagram:{ .mdx-pulse title="Added on October 18, 2022" }
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user