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:
squidfunk
parent
63683eb3c5
commit
31eafc9d4b
13
CHANGELOG
13
CHANGELOG
@ -1,3 +1,16 @@
|
||||
mkdocs-material-9.5.1+insiders-4.47.0 (2023-12-08)
|
||||
|
||||
* Added support for staying on page when switching languages
|
||||
* Added configurable logging capabilities to projects plugin
|
||||
* Removed temporary warning on blog plugin authors file format change
|
||||
* Fixed projects plugin logging messages twice on Linux systems
|
||||
* Fixed projects plugin trying to hoist theme assets of divergent themes
|
||||
* Fixed compatibility of optimize plugin and projects plugin
|
||||
* Fixed compatibility of social plugin and projects plugin
|
||||
* Fixed #6448: Code line selection broken for code blocks with custom ids
|
||||
* Fixed #6437: Projects plugin crashing for certain site URL configurations
|
||||
* Fixed #6414: Projects plugin doesn't prefix messages coming from projects
|
||||
|
||||
mkdocs-material-9.5.1 (2023-12-08)
|
||||
|
||||
* Updated Greek translations
|
||||
|
||||
@ -2,6 +2,19 @@
|
||||
|
||||
## Material for MkDocs Insiders
|
||||
|
||||
### 4.47.0 <small>December 8, 2023</small> { id="4.47.0" }
|
||||
|
||||
- Added support for staying on page when switching languages
|
||||
- Added configurable logging capabilities to projects plugin
|
||||
- Removed temporary warning on blog plugin authors file format change
|
||||
- Fixed projects plugin logging messages twice on Linux systems
|
||||
- Fixed projects plugin trying to hoist theme assets of divergent themes
|
||||
- Fixed compatibility of optimize plugin and projects plugin
|
||||
- Fixed compatibility of social plugin and projects plugin
|
||||
- Fixed #6448: Code line selection broken for code blocks with custom ids
|
||||
- Fixed #6437: Projects plugin crashing for certain site URL configurations
|
||||
- Fixed #6414: Projects plugin doesn't prefix messages coming from projects
|
||||
|
||||
### 4.46.0 <small>November 26, 2023</small> { id="4.46.0" }
|
||||
|
||||
- Added support for author profiles in blog plugin
|
||||
|
||||
@ -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 19 additional features__ that you can __start using now__, and
|
||||
access to 20 additional features__ that you can __start using now__, and
|
||||
which are currently exclusively available to sponsors:
|
||||
|
||||
<div class="mdx-columns" markdown>
|
||||
|
||||
- [x] [Stay on page when switching languages] :material-alert-decagram:{ .mdx-pulse title="Added on December 8, 2023" }
|
||||
- [x] [Blog plugin: author profiles] :material-alert-decagram:{ .mdx-pulse title="Added on November 26, 2023" }
|
||||
- [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] [Projects plugin]
|
||||
- [x] [Instant prefetching]
|
||||
- [x] [Social plugin: custom layouts]
|
||||
- [x] [Social plugin: background images]
|
||||
@ -308,6 +309,7 @@ are released for general availability.
|
||||
- [x] [Social plugin: background images]
|
||||
- [x] [Code range selection]
|
||||
- [x] [Code annotations: custom selectors]
|
||||
- [x] [Stay on page when switching languages]
|
||||
- [ ] more to come...
|
||||
|
||||
[Projects plugin]: ../plugins/projects.md
|
||||
@ -315,6 +317,7 @@ are released for general availability.
|
||||
[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
|
||||
[Stay on page when switching languages]: ../setup/changing-the-language.md#stay-on-page
|
||||
|
||||
### Goals completed
|
||||
|
||||
|
||||
@ -183,6 +183,81 @@ plugins:
|
||||
cache_dir: my/custom/dir
|
||||
```
|
||||
|
||||
### Logging
|
||||
|
||||
The following settings are available for logging:
|
||||
|
||||
---
|
||||
|
||||
#### <!-- md:setting config.log -->
|
||||
|
||||
<!-- md:sponsors -->
|
||||
<!-- md:version insiders-4.47.0 -->
|
||||
<!-- md:default `true` -->
|
||||
|
||||
Use this setting to control whether the plugin should display log messages from
|
||||
projects when building your site. While not neing recommended, you can disable
|
||||
logging with:
|
||||
|
||||
``` yaml
|
||||
plugins:
|
||||
- projects:
|
||||
log: false
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
#### <!-- md:setting config.log_level -->
|
||||
|
||||
<!-- md:sponsors -->
|
||||
<!-- md:version insiders-4.47.0 -->
|
||||
<!-- md:default `info` -->
|
||||
|
||||
Use this setting to control the log level that the plugin should employ when
|
||||
encountering errors, which requires that the [`log`][config.log] setting is
|
||||
enabled. The following log levels are available:
|
||||
|
||||
=== "`error`"
|
||||
|
||||
``` yaml
|
||||
plugins:
|
||||
- projects:
|
||||
log_level: error
|
||||
```
|
||||
|
||||
Only errors are reported.
|
||||
|
||||
=== "`warn`"
|
||||
|
||||
``` yaml
|
||||
plugins:
|
||||
- projects:
|
||||
log_level: warn
|
||||
```
|
||||
|
||||
Errors and warnings are reported, terminating the build in
|
||||
[`strict`][mkdocs.strict] mode.
|
||||
|
||||
=== "`info`"
|
||||
|
||||
``` yaml
|
||||
plugins:
|
||||
- projects:
|
||||
log_level: info
|
||||
```
|
||||
|
||||
Errors, warnings and informational messages are reported.
|
||||
|
||||
=== "`debug`"
|
||||
|
||||
``` yaml
|
||||
plugins:
|
||||
- projects:
|
||||
log_level: debug
|
||||
```
|
||||
|
||||
All messages are reported, including debug messages.
|
||||
|
||||
### Projects
|
||||
|
||||
The following settings are available for projects:
|
||||
|
||||
@ -277,7 +277,6 @@ enabled. The following log levels are available:
|
||||
|
||||
Errors are only reported when using the `--verbose` flag.
|
||||
|
||||
|
||||
### Social cards
|
||||
|
||||
The following settings are available for social card generation:
|
||||
|
||||
@ -36,6 +36,23 @@
|
||||
"type": "string",
|
||||
"default": ".cache/plugins/projects"
|
||||
},
|
||||
"log": {
|
||||
"title": "Enable logging",
|
||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.log",
|
||||
"type": "boolean",
|
||||
"default": true
|
||||
},
|
||||
"log_level": {
|
||||
"title": "Log level",
|
||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.log_level",
|
||||
"enum": [
|
||||
"error",
|
||||
"warn",
|
||||
"info",
|
||||
"debug"
|
||||
],
|
||||
"default": "warn"
|
||||
},
|
||||
"projects": {
|
||||
"title": "Enable projects",
|
||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.projects",
|
||||
|
||||
@ -42,6 +42,22 @@
|
||||
"type": "boolean",
|
||||
"default": true
|
||||
},
|
||||
"log": {
|
||||
"title": "Enable logging",
|
||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.log",
|
||||
"type": "boolean",
|
||||
"default": true
|
||||
},
|
||||
"log_level": {
|
||||
"title": "Log level",
|
||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.log_level",
|
||||
"enum": [
|
||||
"warn",
|
||||
"info",
|
||||
"ignore"
|
||||
],
|
||||
"default": "warn"
|
||||
},
|
||||
"cards_dir": {
|
||||
"title": "Social cards directory",
|
||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cards_dir",
|
||||
|
||||
@ -97,6 +97,38 @@ The following properties are available for each alternate language:
|
||||
[ISO 639-1 language code]: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
|
||||
[Language selector preview]: ../assets/screenshots/language-selection.png
|
||||
|
||||
#### Stay on page :material-alert-decagram:{ .mdx-pulse title="Added on December 8, 2023" }
|
||||
|
||||
<!-- md:sponsors -->
|
||||
<!-- md:version insiders-4.47.0 -->
|
||||
<!-- md:flag experimental -->
|
||||
|
||||
[Insiders] improves the user experience when switching between languages, e.g.,
|
||||
if language `en` and `de` contain a page with the same path name, the user will
|
||||
stay on the current page:
|
||||
|
||||
=== "Insiders"
|
||||
|
||||
```
|
||||
docs.example.com/en/ -> docs.example.com/de/
|
||||
docs.example.com/en/foo/ -> docs.example.com/de/foo/
|
||||
docs.example.com/en/bar/ -> docs.example.com/de/bar/
|
||||
```
|
||||
|
||||
=== "Material for MkDocs"
|
||||
|
||||
```
|
||||
docs.example.com/en/ -> docs.example.com/de/
|
||||
docs.example.com/en/foo/ -> docs.example.com/de/
|
||||
docs.example.com/en/bar/ -> docs.example.com/de/
|
||||
```
|
||||
|
||||
No configuration is necessary. We're working hard on improving multi-language
|
||||
support in 2024, including making switching between languages even more seamless
|
||||
in the future.
|
||||
|
||||
[Insiders]: ../insiders/index.md
|
||||
|
||||
### Directionality
|
||||
|
||||
<!-- md:version 2.5.0 -->
|
||||
|
||||
Loading…
Reference in New Issue
Block a user