mkdocs/mkdocs (mkdocs)
### [`v1.6.0`](https://togithub.com/mkdocs/mkdocs/releases/tag/1.6.0)
[Compare Source](https://togithub.com/mkdocs/mkdocs/compare/1.5.3...1.6.0)
#### Local preview
- `mkdocs serve` no longer locks up the browser when more than 5 tabs are open. This is achieved by closing the polling connection whenever a tab becomes inactive. Background tabs will no longer auto-reload either - that will instead happen as soon the tab is opened again. Context: [#3391](https://togithub.com/mkdocs/mkdocs/issues/3391)
- New flag `serve --open` to open the site in a browser.\
After the first build is finished, this flag will cause the default OS Web browser to be opened at the home page of the local site.\
Context: [#3500](https://togithub.com/mkdocs/mkdocs/issues/3500)
##### Drafts
> \[!warning]
> **Changed from version 1.5:**
>
> **The `exclude_docs` config was split up into two separate concepts.**
The `exclude_docs` config no longer has any special behavior for `mkdocs serve` - it now always completely excludes the listed documents from the site.
If you wish to use the "drafts" functionality like the `exclude_docs` key used to do in MkDocs 1.5, please switch to the **new config key `draft_docs`**.
See [documentation](https://www.mkdocs.org/user-guide/configuration/#exclude_docs).
Other changes:
- Reduce warning levels when a "draft" page has a link to a non-existent file. Context: [#3449](https://togithub.com/mkdocs/mkdocs/issues/3449)
#### Update to deduction of page titles
MkDocs 1.5 had a change in behavior in deducing the page titles from the first heading. Unfortunately this could cause unescaped HTML tags or entities to appear in edge cases.
Now tags are always fully sanitized from the title. Though it still remains the case that [`Page.title`](https://www.mkdocs.org/dev-guide/api/#mkdocs.structure.files.pages.Page.title) is expected to contain HTML entities and is passed directly to the themes.
Images (notably, emojis in some extensions) get preserved in the title only through their `alt` attribute's value.
Context: [#3564](https://togithub.com/mkdocs/mkdocs/issues/3564), [#3578](https://togithub.com/mkdocs/mkdocs/issues/3578)
#### Themes
- Built-in themes now also support Polish language ([#3613](https://togithub.com/mkdocs/mkdocs/issues/3613))
##### "readthedocs" theme
- Fix: "readthedocs" theme can now correctly handle deeply nested nav configurations (over 2 levels deep), without confusedly expanding all sections and jumping around vertically. ([#3464](https://togithub.com/mkdocs/mkdocs/issues/3464))
- Fix: "readthedocs" theme now shows a link to the repository (with a generic logo) even when isn't one of the 3 known hosters. ([#3435](https://togithub.com/mkdocs/mkdocs/issues/3435))
- "readthedocs" theme now also has translation for the word "theme" in the footer that mistakenly always remained in English. ([#3613](https://togithub.com/mkdocs/mkdocs/issues/3613), [#3625](https://togithub.com/mkdocs/mkdocs/issues/3625))
##### "mkdocs" theme
The "mkdocs" theme got a big update to a newer version of Bootstrap, meaning a slight overhaul of styles. Colors (most notably of admonitions) have much better contrast.
The "mkdocs" theme now has support for dark mode - both automatic (based on the OS/browser setting) and with a manual toggle. Both of these options are **not** enabled by default and need to be configured explicitly.\
See `color_mode`, `user_color_mode_toggle` in [**documentation**](https://www.mkdocs.org/user-guide/choosing-your-theme/#mkdocs).
> \[!warning]
> **Possible breaking change:**
>
> jQuery is no longer included into the "mkdocs" theme. If you were relying on it in your scripts, you will need to separately add it first (into mkdocs.yml) as an extra script:
>
> ```yaml
> extra_javascript:
> - https://code.jquery.com/jquery-3.7.1.min.js
> ```
>
> Or even better if the script file is copied and included from your docs dir.
Context: [#3493](https://togithub.com/mkdocs/mkdocs/issues/3493), [#3649](https://togithub.com/mkdocs/mkdocs/issues/3649)
#### Configuration
##### New "`enabled`" setting for all plugins
You may have seen some plugins take up the convention of having a setting `enabled: false` (or usually controlled through an environment variable) to make the plugin do nothing.
Now *every* plugin has this setting. Plugins can still *choose* to implement this config themselves and decide how it behaves (and unless they drop older versions of MkDocs, they still should for now), but now there's always a fallback for every plugin.
See [**documentation**](https://www.mkdocs.org/user-guide/configuration/#enabled-option). Context: [#3395](https://togithub.com/mkdocs/mkdocs/issues/3395)
#### Validation
##### Validation of hyperlinks between pages
##### Absolute links
> Historically, within Markdown, MkDocs only recognized **relative** links that lead to another physical `*.md` document (or media file). This is a good convention to follow because then the source pages are also freely browsable without MkDocs, for example on GitHub. Whereas absolute links were left unmodified (making them often not work as expected or, more recently, warned against).
If you dislike having to always use relative links, now you can opt into absolute links and have them work correctly.
If you set the setting `validation.links.absolute_links` to the new value `relative_to_docs`, all Markdown links starting with `/` will be understood as being relative to the `docs_dir` root. The links will then be validated for correctness according to all the other rules that were already working for relative links in prior versions of MkDocs. For the HTML output, these links will still be turned relative so that the site still works reliably.
So, now any document (e.g. "dir1/foo.md") can link to the document "dir2/bar.md" as `[link](/dir2/bar.md)`, in addition to the previously only correct way `[link](../dir2/bar.md)`.
You have to enable the setting, though. The default is still to just skip any processing of such links.
See [**documentation**](https://www.mkdocs.org/user-guide/configuration/#validation-of-absolute-links). Context: [#3485](https://togithub.com/mkdocs/mkdocs/issues/3485)
##### Absolute links within nav
Absolute links within the `nav:` config were also always skipped. It is now possible to also validate them in the same way with `validation.nav.absolute_links`. Though it makes a bit less sense because then the syntax is simply redundant with the syntax that comes without the leading slash.
##### Anchors
There is a new config setting that is recommended to enable warnings for:
```yaml
validation:
anchors: warn
```
Example of a warning that this can produce:
```text
WARNING - Doc file 'foo/example.md' contains a link '../bar.md#some-heading', but the doc 'foo/bar.md' does not contain an anchor '#some-heading'.
```
Any of the below methods of declaring an anchor will be detected by MkDocs:
```markdown
#### Heading producing an anchor
#### Another heading {#custom-anchor-for-heading-using-attr-list}
[](){#markdown-anchor-using-attr-list}
```
Plugins and extensions that insert anchors, in order to be compatible with this, need to be developed as treeprocessors that insert `etree` elements as their mode of operation, rather than raw HTML which is undetectable for this purpose.
If you as a user are dealing with falsely reported missing anchors and there's no way to resolve this, you can choose to disable these messages by setting this option to `ignore` (and they are at INFO level by default anyway).
See [**documentation**](https://www.mkdocs.org/user-guide/configuration/#validation). Context: [#3463](https://togithub.com/mkdocs/mkdocs/issues/3463)
Other changes:
- When the `nav` config is not specified at all, the `not_in_nav` setting (originally added in 1.5.0) gains an additional behavior: documents covered by `not_in_nav` will not be part of the automatically deduced navigation. Context: [#3443](https://togithub.com/mkdocs/mkdocs/issues/3443)
- Fix: the `!relative` YAML tag for `markdown_extensions` (originally added in 1.5.0) - it was broken in many typical use cases.
See [**documentation**](https://www.mkdocs.org/user-guide/configuration/#paths-relative-to-the-current-file-or-site). Context: [#3466](https://togithub.com/mkdocs/mkdocs/issues/3466)
- Config validation now exits on first error, to avoid showing bizarre secondary errors. Context: [#3437](https://togithub.com/mkdocs/mkdocs/issues/3437)
- MkDocs used to shorten error messages for unexpected errors such as "file not found", but that is no longer the case, the full error message and stack trace will be possible to see (unless the error has a proper handler, of course). Context: [#3445](https://togithub.com/mkdocs/mkdocs/issues/3445)
#### Upgrades for plugin developers
##### Plugins can add multiple handlers for the same event type, at multiple priorities
See [`mkdocs.plugins.CombinedEvent`](https://www.mkdocs.org/dev-guide/plugins/#mkdocs.plugins.CombinedEvent) in [**documentation**](https://www.mkdocs.org/dev-guide/plugins/#event-priorities). Context: [#3448](https://togithub.com/mkdocs/mkdocs/issues/3448)
##### Enabling true generated files and expanding the [`File`](https://www.mkdocs.org/dev-guide/api/#mkdocs.structure.files.File) API
See [**documentation**](https://www.mkdocs.org/dev-guide/api/#mkdocs.structure.files.File).
- There is a new pair of attributes [`File.content_string`](https://www.mkdocs.org/dev-guide/api/#mkdocs.structure.files.File.content_string]/\[\`content_bytes\`]\[mkdocs.structure.files.File.content_bytes) that becomes the official API for obtaining the content of a file and is used by MkDocs itself.
This replaces the old approach where one had to manually read the file located at [`File.abs_src_path`](https://www.mkdocs.org/dev-guide/api/#mkdocs.structure.files.File.abs_src_path), although that is still the primary action that these new attributes do under the hood.
- The content of a `File` can be backed by a string and no longer has to be a real existing file at `abs_src_path`.
It is possible to **set** the attribute `File.content_string` or `File.content_bytes` and it will take precedence over `abs_src_path`.
Further, `abs_src_path` is no longer guaranteed to be present and can be `None` instead. MkDocs itself still uses physical files in all cases, but eventually plugins will appear that don't populate this attribute.
- There is a new constructor [`File.generated()`](https://www.mkdocs.org/dev-guide/api/#mkdocs.structure.files.File.generated) that should be used by plugins instead of the `File()` constructor. It is much more convenient because one doesn't need to manually look up the values such as `docs_dir` and `use_directory_urls`. Its signature is one of:
```python
f = File.generated(config: MkDocsConfig, src_uri: str, content: str | bytes)
f = File.generated(config: MkDocsConfig, src_uri: str, abs_src_path: str)
```
This way, it is now extremely easy to add a virtual file even from a hook:
```python
def on_files(files: Files, config: MkDocsConfig):
files.append(File.generated(config, 'fake/path.md', content="Hello, world!"))
```
For large content it is still best to use physical files, but one no longer needs to manipulate the path by providing a fake unused `docs_dir`.
- There is a new attribute [`File.generated_by`](https://www.mkdocs.org/dev-guide/api/#mkdocs.structure.files.File.generated_by) that arose by convention - for generated files it should be set to the name of the plugin (the key in the `plugins:` collection) that produced this file. This attribute is populated automatically when using the `File.generated()` constructor.
- It is possible to set the [`edit_uri`](https://www.mkdocs.org/dev-guide/api/#mkdocs.structure.files.File.edit_uri) attribute of a `File`, for example from a plugin or hook, to make it different from the default (equal to `src_uri`), and this will be reflected in the edit link of the document. This can be useful because some pages aren't backed by a real file and are instead created dynamically from some other source file or script. So a hook could set the `edit_uri` to that source file or script accordingly.
- The `File` object now stores its original `src_dir`, `dest_dir`, `use_directory_urls` values as attributes.
- Fields of `File` are computed on demand but cached. Only the three above attributes are primary ones, and partly also [`dest_uri`](https://www.mkdocs.org/dev-guide/api/#mkdocs.structure.files.File.dest_uri). This way, it is possible to, for example, overwrite `dest_uri` of a `File`, and `abs_dest_path` will be calculated based on it. However you need to clear the attribute first using `del f.abs_dest_path`, because the values are cached.
- `File` instances are now hashable (can be used as keys of a `dict`). Two files can no longer be considered "equal" unless it's the exact same instance of `File`.
Other changes:
- The internal storage of `File` objects inside a `Files` object has been reworked, so any plugins that choose to access `Files._files` will get a deprecation warning.
- The order of `File` objects inside a `Files` collection is no longer significant when automatically inferring the `nav`. They get forcibly sorted according to the default alphabetic order.
Context: [#3451](https://togithub.com/mkdocs/mkdocs/issues/3451), [#3463](https://togithub.com/mkdocs/mkdocs/issues/3463)
#### Hooks and debugging
- Hook files can now import adjacent \*.py files using the `import` statement. Previously this was possible to achieve only through a `sys.path` workaround. See the new mention in [documentation](https://www.mkdocs.org/user-guide/configuration/#hooks). Context: [#3568](https://togithub.com/mkdocs/mkdocs/issues/3568)
- Verbose `-v` log shows the sequence of plugin events in more detail - shows each invoked plugin one by one, not only the event type. Context: [#3444](https://togithub.com/mkdocs/mkdocs/issues/3444)
#### Deprecations
- Python 3.7 is no longer supported, Python 3.12 is officially supported. Context: [#3429](https://togithub.com/mkdocs/mkdocs/issues/3429)
- The theme config file `mkdocs_theme.yml` no longer executes YAML tags. Context: [#3465](https://togithub.com/mkdocs/mkdocs/issues/3465)
- The plugin event `on_page_read_source` is soft-deprecated because there is always a better alternative to it (see the new `File` API or just `on_page_markdown`, depending on the desired interaction).
When multiple plugins/hooks apply this event handler, they trample over each other, so now there is a warning in that case.
See [**documentation**](https://www.mkdocs.org/dev-guide/plugins/#on_page_read_source). Context: [#3503](https://togithub.com/mkdocs/mkdocs/issues/3503)
##### API deprecations
- It is no longer allowed to set `File.page` to a type other than `Page` or a subclass thereof. Context: [#3443](https://togithub.com/mkdocs/mkdocs/issues/3443) - following the deprecation in version 1.5.3 and [#3381](https://togithub.com/mkdocs/mkdocs/issues/3381).
- `Theme._vars` is deprecated - use `theme['foo']` instead of `theme._vars['foo']`
- `utils`: `modified_time()`, `get_html_path()`, `get_url_path()`, `is_html_file()`, `is_template_file()` are removed. `path_to_url()` is deprecated.
- `LiveReloadServer.watch()` no longer accepts a custom callback.
Context: [#3429](https://togithub.com/mkdocs/mkdocs/issues/3429)
#### Misc
- The `sitemap.xml.gz` file is slightly more reproducible and no longer changes on every build, but instead only once per day (upon a date change). Context: [#3460](https://togithub.com/mkdocs/mkdocs/issues/3460)
Other small improvements; see [commit log](https://togithub.com/mkdocs/mkdocs/compare/1.5.3...1.6.0).
timvink/mkdocs-git-revision-date-localized-plugin (mkdocs-git-revision-date-localized-plugin)
### [`v1.2.6`](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/releases/tag/v1.2.6): revision-date-localized v1.2.6
[Compare Source](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/compare/v1.2.5...v1.2.6)
##### What's Changed
- Fix bitbucket CI warning showing up on github actions, by [@timvink](https://togithub.com/timvink) in [https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/issues/136](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/issues/136)
**Full Changelog**: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/compare/v1.2.5...v1.2.6
### [`v1.2.5`](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/releases/tag/v1.2.5): revision-date-localized v1.2.5
[Compare Source](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/compare/v1.2.4...v1.2.5)
#### What's Changed
- Fixing `_vars` deprecation warning by [@dbermuehler](https://togithub.com/dbermuehler) in [https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/132](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/132)
#### New Contributors
- [@dbermuehler](https://togithub.com/dbermuehler) made their first contribution in [https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/132](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/132)
**Full Changelog**: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/compare/v1.2.4...v1.2.5
### [`v1.2.4`](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/releases/tag/v1.2.4): revision-date-localized v1.2.4
[Compare Source](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/compare/v1.2.3...v1.2.4)
- Revert jinja auto escape [#126](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/issues/126)
**Full Changelog**: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/compare/v1.2.3...v1.2.4
### [`v1.2.3`](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/releases/tag/v1.2.3): revision-date-localized v1.2.3
[Compare Source](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/compare/v1.2.2...v1.2.3)
#### What's Changed
- To prepare for next major mkdocs release: For jinja autoescape, mark HTML strings as safe, not needing escaping by [@oprypin](https://togithub.com/oprypin) in [https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/126](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/126)
- Drop support for python 3.7
**Full Changelog**: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/compare/v1.2.2...v1.2.3
### [`v1.2.2`](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/releases/tag/v1.2.2): revision-date-localized v1.2.2
[Compare Source](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/compare/v1.2.1...v1.2.2)
#### What's Changed
- Correctly check for truthiness of `generated_by` by [@oprypin](https://togithub.com/oprypin) in [https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/124](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/124)
- \[fix] get locale for mkdocs-static-i18n by [@satisataka](https://togithub.com/satisataka) in [https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/125](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/125)
#### New Contributors
- [@oprypin](https://togithub.com/oprypin) made their first contribution in [https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/124](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/124)
- [@satisataka](https://togithub.com/satisataka) made their first contribution in [https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/125](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/125)
**Full Changelog**: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/compare/v1.2.1...v1.2.2
### [`v1.2.1`](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/releases/tag/v1.2.1): revision-date-localized v1.2.1
[Compare Source](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/compare/v1.2.0...v1.2.1)
#### What's Changed
- Remove usage of `datetime.utcfromtimestamp` to avoid deprecated warnings in python 3.12 by [@timvink](https://togithub.com/timvink) in [https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/122](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/122)
**Full Changelog**: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/compare/v1.2.0...v1.2.1
Blueswen/mkdocs-glightbox (mkdocs-glightbox)
### [`v0.4.0`](https://togithub.com/blueswen/mkdocs-glightbox/releases/tag/v0.4.0): mkdocs-glightbox-0.4.0
[Compare Source](https://togithub.com/Blueswen/mkdocs-glightbox/compare/v0.3.7...v0.4.0)
- Supported manual mode ([#29](https://togithub.com/Blueswen/mkdocs-glightbox/issues/29))
- Allow calling lightbox methods from other places ([#34](https://togithub.com/Blueswen/mkdocs-glightbox/issues/34))
- Added id to appended script tag ([#38](https://togithub.com/Blueswen/mkdocs-glightbox/issues/38))
- Access theme attribute directly ([#40](https://togithub.com/Blueswen/mkdocs-glightbox/issues/40))
- Better JavaScript Error Handling ([#36](https://togithub.com/Blueswen/mkdocs-glightbox/issues/36))
### [`v0.3.7`](https://togithub.com/blueswen/mkdocs-glightbox/releases/tag/v0.3.7): mkdocs-glightbox-0.3.7
[Compare Source](https://togithub.com/Blueswen/mkdocs-glightbox/compare/v0.3.6...v0.3.7)
- Supported custom background and shadow ([#27](https://togithub.com/Blueswen/mkdocs-glightbox/issues/27))
### [`v0.3.6`](https://togithub.com/blueswen/mkdocs-glightbox/releases/tag/v0.3.6): mkdocs-glightbox-0.3.6
[Compare Source](https://togithub.com/Blueswen/mkdocs-glightbox/compare/v0.3.5...v0.3.6)
- Modified width default to auto prevent zooming large image bug ([#21](https://togithub.com/Blueswen/mkdocs-glightbox/issues/21))
- Supported only enable glightbox with on-glb class in given page ([#28](https://togithub.com/Blueswen/mkdocs-glightbox/issues/28))
### [`v0.3.5`](https://togithub.com/blueswen/mkdocs-glightbox/releases/tag/v0.3.5): mkdocs-glightbox-0.3.5
[Compare Source](https://togithub.com/Blueswen/mkdocs-glightbox/compare/v0.3.4...v0.3.5)
- Supported compatibility with the privacy plugin of Material for MkDocs insiders ([#25](https://togithub.com/Blueswen/mkdocs-glightbox/issues/25))
squidfunk/mkdocs-material (mkdocs-material)
### [`v9.5.28`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.28): mkdocs-material-9.5.28
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.27...9.5.28)
- Fixed [#7313](https://togithub.com/squidfunk/mkdocs-material/issues/7313): Improved tooltips mounted in sidebar when feature is disabled
### [`v9.5.27`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.27): mkdocs-material-9.5.27
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.26...9.5.27)
- Updated Estonian translations
Thanks to [@Eilyre](https://togithub.com/Eilyre) for their contributions
### [`v9.5.26`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.26): mkdocs-material-9.5.26
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.25...9.5.26)
- Fixed [#7232](https://togithub.com/squidfunk/mkdocs-material/issues/7232): Tab switches on scroll when linking tabs (9.5.19 regression)
- Fixed [#7230](https://togithub.com/squidfunk/mkdocs-material/issues/7230): Blog author avatar broken when referring to local file
### [`v9.5.25`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.25): mkdocs-material-9.5.25
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.24...9.5.25)
- Fixed [#7209](https://togithub.com/squidfunk/mkdocs-material/issues/7209): Tags plugin crashing on numeric tags
### [`v9.5.24`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.24): mkdocs-material-9.5.24
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.23...9.5.24)
- Fixed [#7187](https://togithub.com/squidfunk/mkdocs-material/issues/7187): Version selector title rendering issue
### [`v9.5.23`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.23): mkdocs-material-9.5.23
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.22...9.5.23)
- Fixed [#7183](https://togithub.com/squidfunk/mkdocs-material/issues/7183): Edge case in anchor navigation when using instant navigation
- Fixed [#6436](https://togithub.com/squidfunk/mkdocs-material/issues/6436): Version selector not showing version alias
### [`v9.5.22`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.22): mkdocs-material-9.5.22
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.21...9.5.22)
- Fixed [#7170](https://togithub.com/squidfunk/mkdocs-material/issues/7170): Copy button adds empty lines for line spans (9.5.18 regression)
- Fixed [#7160](https://togithub.com/squidfunk/mkdocs-material/issues/7160): Version switching doesn't stay on page (9.5.5 regression)
- Fixed [#5619](https://togithub.com/squidfunk/mkdocs-material/issues/5619): Links in Mermaid.js diagrams not discernible
### [`v9.5.21`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.21): mkdocs-material-9.5.21
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.20...9.5.21)
- Fixed [#7133](https://togithub.com/squidfunk/mkdocs-material/issues/7133): Ensure latest version of Mermaid.js is used
- Fixed [#7125](https://togithub.com/squidfunk/mkdocs-material/issues/7125): Added warning for dotfiles in info plugin
Thanks to [@kamilkrzyskow](https://togithub.com/kamilkrzyskow) for their contributions
### [`v9.5.20`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.20): mkdocs-material-9.5.20
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.19...9.5.20)
- Fixed deprecation warning in privacy plugin (9.5.19 regression)
- Fixed [#7119](https://togithub.com/squidfunk/mkdocs-material/issues/7119): Tags plugin emits deprecation warning (9.5.19 regression)
- Fixed [#7118](https://togithub.com/squidfunk/mkdocs-material/issues/7118): Social plugin crashes if fonts are disabled (9.5.19 regression)
- Fixed [#7085](https://togithub.com/squidfunk/mkdocs-material/issues/7085): Social plugin crashes on Windows when downloading fonts
### [`v9.5.19`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.19): mkdocs-material-9.5.19
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.18...9.5.19)
- Updated MkDocs to 1.6 and limited version to < 2
- Updated Docker image to latest Alpine Linux
- Removed `setup.py`, now that GitHub fully understands `pyproject.toml`
- Improved interop of social plugin with third-party MkDocs themes
- Fixed [#7099](https://togithub.com/squidfunk/mkdocs-material/issues/7099): Blog reading time not rendered correctly for Japanese
- Fixed [#7097](https://togithub.com/squidfunk/mkdocs-material/issues/7097): Improved resilience of tags plugin when no tags are given
- Fixed [#7090](https://togithub.com/squidfunk/mkdocs-material/issues/7090): Active tab indicator in nested content tabs rendering bug
### [`v9.5.18`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.18): mkdocs-material-9.5.18
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.17...9.5.18)
- Refactored tooltips implementation to fix positioning issues
- Fixed [#7044](https://togithub.com/squidfunk/mkdocs-material/issues/7044): Rendering glitch when hovering contributor avatar in Chrome
- Fixed [#7043](https://togithub.com/squidfunk/mkdocs-material/issues/7043): Highlighted lines in code blocks cutoff on mobile
- Fixed [#6910](https://togithub.com/squidfunk/mkdocs-material/issues/6910): Incorrect position of tooltip for page status in sidebar
- Fixed [#6760](https://togithub.com/squidfunk/mkdocs-material/issues/6760): Incorrect position and overly long tooltip in tables
- Fixed [#6488](https://togithub.com/squidfunk/mkdocs-material/issues/6488): Incorrect position and cutoff tooltip in content tabs
### [`v9.5.17`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.17): mkdocs-material-9.5.17
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.16...9.5.17)
- Updated Serbian translations
- Fixed [#7003](https://togithub.com/squidfunk/mkdocs-material/issues/7003): Confusing keyboard interaction for palette toggle
- Fixed [#7001](https://togithub.com/squidfunk/mkdocs-material/issues/7001): Blog posts now show time by default (9.5.16 regression)
- Fixed edge case in backport of social plugin font loading logic
Thanks to [@stcksmsh](https://togithub.com/stcksmsh) for their contributions.
### [`v9.5.16`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.16): mkdocs-material-9.5.16
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.15...9.5.16)
- Updated Russian translations
- Improved error handling and reporting in social plugin
- Improved error handling and reporting in privacy plugin
- Fixed blog plugin not allowing to use time in format strings
- Fixed [#6983](https://togithub.com/squidfunk/mkdocs-material/issues/6983): Social plugin crashes because of Google Fonts API change
Thanks to [@kamilkrzyskow](https://togithub.com/kamilkrzyskow), [@Guts](https://togithub.com/Guts), [@szg-alex-payne](https://togithub.com/szg-alex-payne) and [@natakazakova](https://togithub.com/natakazakova) for their contributions
### [`v9.5.15`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.15): mkdocs-material-9.5.15
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.14...9.5.15)
- Reverted fix for transparent iframes (9.5.14)
- Fixed [#6929](https://togithub.com/squidfunk/mkdocs-material/issues/6929): Interference of social plugin and auto dark mode
- Fixed [#6938](https://togithub.com/squidfunk/mkdocs-material/issues/6938): Giscus shows dark background in light mode (9.5.14 regression)
### [`v9.5.14`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.14): mkdocs-material-9.5.14
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.13...9.5.14)
- Added support for hiding versions from selector when using mike
- Added init system to improve signal handling in Docker image
- Fixed edge cases in exclusion logic of info plugin
- Fixed inability to reset pipeline in search plugin
- Fixed syntax error in Finnish translations
- Fixed [#6917](https://togithub.com/squidfunk/mkdocs-material/issues/6917): UTF-8 encoding problems in blog plugin on Windows
- Fixed [#6889](https://togithub.com/squidfunk/mkdocs-material/issues/6889): Transparent iframes get background color
Thanks to [@kamilkrzyskow](https://togithub.com/kamilkrzyskow), [@yubiuser](https://togithub.com/yubiuser) and [@todeveni](https://togithub.com/todeveni) for their contributions
### [`v9.5.13`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.13): mkdocs-material-9.5.13
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.12...9.5.13)
- Updated Slovak translations
- Improved info plugin interop with projects plugin
- Improved info plugin inclusion/exclusion logic
- Fixed info plugin not gathering files recursively
- Fixed [#6750](https://togithub.com/squidfunk/mkdocs-material/issues/6750): Ensure info plugin packs up all necessary files
Thanks to [@kamilkrzyskow](https://togithub.com/kamilkrzyskow) and [@scepka](https://togithub.com/scepka) for their contributions
### [`v9.5.12`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.12): mkdocs-material-9.5.12
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.11...9.5.12)
- Fixed [#6846](https://togithub.com/squidfunk/mkdocs-material/issues/6846): Some meta tags removed on instant navigation (9.4.2 regression)
- Fixed [#6823](https://togithub.com/squidfunk/mkdocs-material/issues/6823): KaTex not rendering on instant navigation (9.5.5 regression)
- Fixed [#6821](https://togithub.com/squidfunk/mkdocs-material/issues/6821): Privacy plugin doesn't handle URLs with encoded characters
### [`v9.5.11`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.11): mkdocs-material-9.5.11
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.10...9.5.11)
- Updated Finnish translation
### [`v9.5.10`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.10): mkdocs-material-9.5.10
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.9...9.5.10)
- Updated Bahasa Malaysia translations
- Fixed [#6783](https://togithub.com/squidfunk/mkdocs-material/issues/6783): Hide continue reading link for blog posts without separators
- Fixed [#6779](https://togithub.com/squidfunk/mkdocs-material/issues/6779): Incorrect positioning of integrated table of contents
### [`v9.5.9`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.9): mkdocs-material-9.5.9
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.8...9.5.9)
- Fixed navigation pruning with tabs and sections enabled
### [`v9.5.8`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.8): mkdocs-material-9.5.8
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.7...9.5.8)
- Added Tamil translations
- Updated Esperanto translations
- Fixed relative images not being resolved for instant navigation
### [`v9.5.7`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.7): mkdocs-material-9.5.7
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.6...9.5.7)
- Fixed [#6731](https://togithub.com/squidfunk/mkdocs-material/issues/6731): Small images in figures are not centered
- Fixed [#6719](https://togithub.com/squidfunk/mkdocs-material/issues/6719): Instant navigation breaks table of contents (9.5.5 regression)
### [`v9.5.6`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.6): mkdocs-material-9.5.6
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.5...9.5.6)
- Fixed [#6700](https://togithub.com/squidfunk/mkdocs-material/issues/6700): Missing styles for Mermaid.js labels with Markdown
### [`v9.5.5`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.5): mkdocs-material-9.5.5
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.4...9.5.5)
- Updated Tagalog translations
- Updated Pillow to 10.2 to mitigate security vulnerabilities
- Improved resilience of instant navigation
- Fixed [#6687](https://togithub.com/squidfunk/mkdocs-material/issues/6687): Updated Mermaid.js to version 10.7.0 (latest)
- Fixed [#6652](https://togithub.com/squidfunk/mkdocs-material/issues/6652): Keyboard events in custom elements captured
- Fixed [#6582](https://togithub.com/squidfunk/mkdocs-material/issues/6582): Instant navigation doesn't correctly handle alternate URLs
- Fixed [#6565](https://togithub.com/squidfunk/mkdocs-material/issues/6565): Instant navigation doesn't allow for `onclick` handlers
- Fixed [#6345](https://togithub.com/squidfunk/mkdocs-material/issues/6345): Instant navigation sometimes breaks browser back button
- Fixed [#6334](https://togithub.com/squidfunk/mkdocs-material/issues/6334): Instant navigation doesn't correctly position anchors (Safari)
- Fixed [#6275](https://togithub.com/squidfunk/mkdocs-material/issues/6275): Instant navigation doesn't correctly resolve after 404
- Fixed [#6102](https://togithub.com/squidfunk/mkdocs-material/issues/6102): Instant navigation reloads page on same link navigation
### [`v9.5.4`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.4): mkdocs-material-9.5.4
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.3...9.5.4)
- Fixed [#6645](https://togithub.com/squidfunk/mkdocs-material/issues/6645): Local storage with invalid value can break site
- Fixed [#6635](https://togithub.com/squidfunk/mkdocs-material/issues/6635): Tags icons before default ignored if default is set
### [`v9.5.3`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.3): mkdocs-material-9.5.3
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.2...9.5.3)
- Limited version range of MkDocs to < 1.6
- Updated Macedonian translations
- Fixed [#6520](https://togithub.com/squidfunk/mkdocs-material/issues/6520): Group plugin crashes when using mike
- Fixed [#6494](https://togithub.com/squidfunk/mkdocs-material/issues/6494): Hide author's email address if disabled in git-authors plugin
### [`v9.5.2`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.2): mkdocs-material-9.5.2
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.1...9.5.2)
- Fixed types for `slugify` settings in blog plugin config
- Fixed [#6469](https://togithub.com/squidfunk/mkdocs-material/issues/6469): Horizontal scrollbars on MathJax containers
### [`v9.5.1`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.1): mkdocs-material-9.5.1
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.0...9.5.1)
- Updated Greek translations
- Fixed [#6464](https://togithub.com/squidfunk/mkdocs-material/issues/6464): Privacy plugin cannot be enabled
- Fixed [#6461](https://togithub.com/squidfunk/mkdocs-material/issues/6461): Sorting blog posts ignores time component in date
### [`v9.5.0`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.0): mkdocs-material-9.5.0
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.14...9.5.0)
Merged Insiders features of 'Goat's Horn' funding goal
- Added privacy plugin: automatic downloading of external assets
- Added support for card grids and grid layouts
- Added support for improved tooltips
- Added support for content tabs anchor links (deep linking)
- Added support for automatic dark/light mode
- Added support for document contributors
### [`v9.4.14`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.14): mkdocs-material-9.4.14
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.13...9.4.14)
- Added support for linking authors in blog posts
### [`v9.4.13`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.13): mkdocs-material-9.4.13
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.12...9.4.13)
- Fixed [#6365](https://togithub.com/squidfunk/mkdocs-material/issues/6365): Blog plugin pagination links to previous pages broken
- Fixed [#5758](https://togithub.com/squidfunk/mkdocs-material/issues/5758): Updated Mermaid.js to version 10.6.1 (latest)
### [`v9.4.12`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.12): mkdocs-material-9.4.12
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.11...9.4.12)
- Improved blog plugin to generate Unicode-aware slugs by default
- Fixed non-deterministic order of categories in blog plugin
### [`v9.4.11`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.11): mkdocs-material-9.4.11
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.10...9.4.11)
- Fixed [#6364](https://togithub.com/squidfunk/mkdocs-material/issues/6364): Search plugin crashing when enabling theme while serving
- Fixed blog plugin crashing when disabling pagination
### [`v9.4.10`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.10): mkdocs-material-9.4.10
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.9...9.4.10)
- Fixed [#6356](https://togithub.com/squidfunk/mkdocs-material/issues/6356): Version selector can't be disabled via mike's configuration
- Fixed [#6281](https://togithub.com/squidfunk/mkdocs-material/issues/6281): Navigation not rendering due to Safari bug (9.4.2 regression)
- Fixed [#6261](https://togithub.com/squidfunk/mkdocs-material/issues/6261): Navigation expansion animates on first load (9.4.2 regression)
### [`v9.4.9`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.9): mkdocs-material-9.4.9
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.8...9.4.9)
- Fixed [#6344](https://togithub.com/squidfunk/mkdocs-material/issues/6344): Long entries cutoff in table of contents
- Fixed [#6336](https://togithub.com/squidfunk/mkdocs-material/issues/6336): Custom template for glob archive not working with pagination
- Fixed [#6328](https://togithub.com/squidfunk/mkdocs-material/issues/6328): Blog plugin crashes for locales with dashes, e.g. `pt-BR`
- Fixed [#6327](https://togithub.com/squidfunk/mkdocs-material/issues/6327): Copy-to-clipboard button doesn't trim trailing line feed
- Fixed [#6302](https://togithub.com/squidfunk/mkdocs-material/issues/6302): Version strings not matched when using mike, only aliases
- Fixed instant navigation progress indicator for gzipped content in Chrome
- Fixed rendering bug on details marker rotation in Firefox
### [`v9.4.8`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.8): mkdocs-material-9.4.8
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.7...9.4.8)
- Fixed invalid local address replacement when using instant loading
- Fixed [#6275](https://togithub.com/squidfunk/mkdocs-material/issues/6275): Crash after navigation caused 404 when using instant loading
### [`v9.4.7`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.7): mkdocs-material-9.4.7
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.6...9.4.7)
- Added Azerbaijani translations
### [`v9.4.6`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.6): mkdocs-material-9.4.6
[Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.5...9.4.6)
- Updated Danish and Norwegian (Nynorsk) translations
- Fixed [#6169](https://togithub.com/squidfunk/mkdocs-material/issues/6169): Blog post metadata layout overflows on small screens
facelessuser/mkdocs-material-extensions (mkdocs-material-extensions)
### [`v1.3.1`](https://togithub.com/facelessuser/mkdocs-material-extensions/blob/HEAD/changelog.md#131)
[Compare Source](https://togithub.com/facelessuser/mkdocs-material-extensions/compare/1.3...1.3.1)
- **FIX**: Better deprecation warning.
### [`v1.3`](https://togithub.com/facelessuser/mkdocs-material-extensions/blob/HEAD/changelog.md#131)
[Compare Source](https://togithub.com/facelessuser/mkdocs-material-extensions/compare/1.2...1.3)
- **FIX**: Better deprecation warning.
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Enabled.
â™» Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.
[ ] If you want to rebase/retry this PR, check this box
This PR has been generated by Mend Renovate. View repository job log here.
This PR contains the following updates:
==1.5.3
->==1.6.0
==1.2.0
->==1.2.6
==0.3.4
->==0.4.0
==9.4.5
->==9.5.28
==1.2
->==1.3.1
Release Notes
mkdocs/mkdocs (mkdocs)
### [`v1.6.0`](https://togithub.com/mkdocs/mkdocs/releases/tag/1.6.0) [Compare Source](https://togithub.com/mkdocs/mkdocs/compare/1.5.3...1.6.0) #### Local preview - `mkdocs serve` no longer locks up the browser when more than 5 tabs are open. This is achieved by closing the polling connection whenever a tab becomes inactive. Background tabs will no longer auto-reload either - that will instead happen as soon the tab is opened again. Context: [#3391](https://togithub.com/mkdocs/mkdocs/issues/3391) - New flag `serve --open` to open the site in a browser.\ After the first build is finished, this flag will cause the default OS Web browser to be opened at the home page of the local site.\ Context: [#3500](https://togithub.com/mkdocs/mkdocs/issues/3500) ##### Drafts > \[!warning] > **Changed from version 1.5:** > > **The `exclude_docs` config was split up into two separate concepts.** The `exclude_docs` config no longer has any special behavior for `mkdocs serve` - it now always completely excludes the listed documents from the site. If you wish to use the "drafts" functionality like the `exclude_docs` key used to do in MkDocs 1.5, please switch to the **new config key `draft_docs`**. See [documentation](https://www.mkdocs.org/user-guide/configuration/#exclude_docs). Other changes: - Reduce warning levels when a "draft" page has a link to a non-existent file. Context: [#3449](https://togithub.com/mkdocs/mkdocs/issues/3449) #### Update to deduction of page titles MkDocs 1.5 had a change in behavior in deducing the page titles from the first heading. Unfortunately this could cause unescaped HTML tags or entities to appear in edge cases. Now tags are always fully sanitized from the title. Though it still remains the case that [`Page.title`](https://www.mkdocs.org/dev-guide/api/#mkdocs.structure.files.pages.Page.title) is expected to contain HTML entities and is passed directly to the themes. Images (notably, emojis in some extensions) get preserved in the title only through their `alt` attribute's value. Context: [#3564](https://togithub.com/mkdocs/mkdocs/issues/3564), [#3578](https://togithub.com/mkdocs/mkdocs/issues/3578) #### Themes - Built-in themes now also support Polish language ([#3613](https://togithub.com/mkdocs/mkdocs/issues/3613)) ##### "readthedocs" theme - Fix: "readthedocs" theme can now correctly handle deeply nested nav configurations (over 2 levels deep), without confusedly expanding all sections and jumping around vertically. ([#3464](https://togithub.com/mkdocs/mkdocs/issues/3464)) - Fix: "readthedocs" theme now shows a link to the repository (with a generic logo) even when isn't one of the 3 known hosters. ([#3435](https://togithub.com/mkdocs/mkdocs/issues/3435)) - "readthedocs" theme now also has translation for the word "theme" in the footer that mistakenly always remained in English. ([#3613](https://togithub.com/mkdocs/mkdocs/issues/3613), [#3625](https://togithub.com/mkdocs/mkdocs/issues/3625)) ##### "mkdocs" theme The "mkdocs" theme got a big update to a newer version of Bootstrap, meaning a slight overhaul of styles. Colors (most notably of admonitions) have much better contrast. The "mkdocs" theme now has support for dark mode - both automatic (based on the OS/browser setting) and with a manual toggle. Both of these options are **not** enabled by default and need to be configured explicitly.\ See `color_mode`, `user_color_mode_toggle` in [**documentation**](https://www.mkdocs.org/user-guide/choosing-your-theme/#mkdocs). > \[!warning] > **Possible breaking change:** > > jQuery is no longer included into the "mkdocs" theme. If you were relying on it in your scripts, you will need to separately add it first (into mkdocs.yml) as an extra script: > > ```yaml > extra_javascript: > - https://code.jquery.com/jquery-3.7.1.min.js > ``` > > Or even better if the script file is copied and included from your docs dir. Context: [#3493](https://togithub.com/mkdocs/mkdocs/issues/3493), [#3649](https://togithub.com/mkdocs/mkdocs/issues/3649) #### Configuration ##### New "`enabled`" setting for all plugins You may have seen some plugins take up the convention of having a setting `enabled: false` (or usually controlled through an environment variable) to make the plugin do nothing. Now *every* plugin has this setting. Plugins can still *choose* to implement this config themselves and decide how it behaves (and unless they drop older versions of MkDocs, they still should for now), but now there's always a fallback for every plugin. See [**documentation**](https://www.mkdocs.org/user-guide/configuration/#enabled-option). Context: [#3395](https://togithub.com/mkdocs/mkdocs/issues/3395) #### Validation ##### Validation of hyperlinks between pages ##### Absolute links > Historically, within Markdown, MkDocs only recognized **relative** links that lead to another physical `*.md` document (or media file). This is a good convention to follow because then the source pages are also freely browsable without MkDocs, for example on GitHub. Whereas absolute links were left unmodified (making them often not work as expected or, more recently, warned against). If you dislike having to always use relative links, now you can opt into absolute links and have them work correctly. If you set the setting `validation.links.absolute_links` to the new value `relative_to_docs`, all Markdown links starting with `/` will be understood as being relative to the `docs_dir` root. The links will then be validated for correctness according to all the other rules that were already working for relative links in prior versions of MkDocs. For the HTML output, these links will still be turned relative so that the site still works reliably. So, now any document (e.g. "dir1/foo.md") can link to the document "dir2/bar.md" as `[link](/dir2/bar.md)`, in addition to the previously only correct way `[link](../dir2/bar.md)`. You have to enable the setting, though. The default is still to just skip any processing of such links. See [**documentation**](https://www.mkdocs.org/user-guide/configuration/#validation-of-absolute-links). Context: [#3485](https://togithub.com/mkdocs/mkdocs/issues/3485) ##### Absolute links within nav Absolute links within the `nav:` config were also always skipped. It is now possible to also validate them in the same way with `validation.nav.absolute_links`. Though it makes a bit less sense because then the syntax is simply redundant with the syntax that comes without the leading slash. ##### Anchors There is a new config setting that is recommended to enable warnings for: ```yaml validation: anchors: warn ``` Example of a warning that this can produce: ```text WARNING - Doc file 'foo/example.md' contains a link '../bar.md#some-heading', but the doc 'foo/bar.md' does not contain an anchor '#some-heading'. ``` Any of the below methods of declaring an anchor will be detected by MkDocs: ```markdown #### Heading producing an anchor #### Another heading {#custom-anchor-for-heading-using-attr-list} [](){#markdown-anchor-using-attr-list} ``` Plugins and extensions that insert anchors, in order to be compatible with this, need to be developed as treeprocessors that insert `etree` elements as their mode of operation, rather than raw HTML which is undetectable for this purpose. If you as a user are dealing with falsely reported missing anchors and there's no way to resolve this, you can choose to disable these messages by setting this option to `ignore` (and they are at INFO level by default anyway). See [**documentation**](https://www.mkdocs.org/user-guide/configuration/#validation). Context: [#3463](https://togithub.com/mkdocs/mkdocs/issues/3463) Other changes: - When the `nav` config is not specified at all, the `not_in_nav` setting (originally added in 1.5.0) gains an additional behavior: documents covered by `not_in_nav` will not be part of the automatically deduced navigation. Context: [#3443](https://togithub.com/mkdocs/mkdocs/issues/3443) - Fix: the `!relative` YAML tag for `markdown_extensions` (originally added in 1.5.0) - it was broken in many typical use cases. See [**documentation**](https://www.mkdocs.org/user-guide/configuration/#paths-relative-to-the-current-file-or-site). Context: [#3466](https://togithub.com/mkdocs/mkdocs/issues/3466) - Config validation now exits on first error, to avoid showing bizarre secondary errors. Context: [#3437](https://togithub.com/mkdocs/mkdocs/issues/3437) - MkDocs used to shorten error messages for unexpected errors such as "file not found", but that is no longer the case, the full error message and stack trace will be possible to see (unless the error has a proper handler, of course). Context: [#3445](https://togithub.com/mkdocs/mkdocs/issues/3445) #### Upgrades for plugin developers ##### Plugins can add multiple handlers for the same event type, at multiple priorities See [`mkdocs.plugins.CombinedEvent`](https://www.mkdocs.org/dev-guide/plugins/#mkdocs.plugins.CombinedEvent) in [**documentation**](https://www.mkdocs.org/dev-guide/plugins/#event-priorities). Context: [#3448](https://togithub.com/mkdocs/mkdocs/issues/3448) ##### Enabling true generated files and expanding the [`File`](https://www.mkdocs.org/dev-guide/api/#mkdocs.structure.files.File) API See [**documentation**](https://www.mkdocs.org/dev-guide/api/#mkdocs.structure.files.File). - There is a new pair of attributes [`File.content_string`](https://www.mkdocs.org/dev-guide/api/#mkdocs.structure.files.File.content_string]/\[\`content_bytes\`]\[mkdocs.structure.files.File.content_bytes) that becomes the official API for obtaining the content of a file and is used by MkDocs itself. This replaces the old approach where one had to manually read the file located at [`File.abs_src_path`](https://www.mkdocs.org/dev-guide/api/#mkdocs.structure.files.File.abs_src_path), although that is still the primary action that these new attributes do under the hood. - The content of a `File` can be backed by a string and no longer has to be a real existing file at `abs_src_path`. It is possible to **set** the attribute `File.content_string` or `File.content_bytes` and it will take precedence over `abs_src_path`. Further, `abs_src_path` is no longer guaranteed to be present and can be `None` instead. MkDocs itself still uses physical files in all cases, but eventually plugins will appear that don't populate this attribute. - There is a new constructor [`File.generated()`](https://www.mkdocs.org/dev-guide/api/#mkdocs.structure.files.File.generated) that should be used by plugins instead of the `File()` constructor. It is much more convenient because one doesn't need to manually look up the values such as `docs_dir` and `use_directory_urls`. Its signature is one of: ```python f = File.generated(config: MkDocsConfig, src_uri: str, content: str | bytes) f = File.generated(config: MkDocsConfig, src_uri: str, abs_src_path: str) ``` This way, it is now extremely easy to add a virtual file even from a hook: ```python def on_files(files: Files, config: MkDocsConfig): files.append(File.generated(config, 'fake/path.md', content="Hello, world!")) ``` For large content it is still best to use physical files, but one no longer needs to manipulate the path by providing a fake unused `docs_dir`. - There is a new attribute [`File.generated_by`](https://www.mkdocs.org/dev-guide/api/#mkdocs.structure.files.File.generated_by) that arose by convention - for generated files it should be set to the name of the plugin (the key in the `plugins:` collection) that produced this file. This attribute is populated automatically when using the `File.generated()` constructor. - It is possible to set the [`edit_uri`](https://www.mkdocs.org/dev-guide/api/#mkdocs.structure.files.File.edit_uri) attribute of a `File`, for example from a plugin or hook, to make it different from the default (equal to `src_uri`), and this will be reflected in the edit link of the document. This can be useful because some pages aren't backed by a real file and are instead created dynamically from some other source file or script. So a hook could set the `edit_uri` to that source file or script accordingly. - The `File` object now stores its original `src_dir`, `dest_dir`, `use_directory_urls` values as attributes. - Fields of `File` are computed on demand but cached. Only the three above attributes are primary ones, and partly also [`dest_uri`](https://www.mkdocs.org/dev-guide/api/#mkdocs.structure.files.File.dest_uri). This way, it is possible to, for example, overwrite `dest_uri` of a `File`, and `abs_dest_path` will be calculated based on it. However you need to clear the attribute first using `del f.abs_dest_path`, because the values are cached. - `File` instances are now hashable (can be used as keys of a `dict`). Two files can no longer be considered "equal" unless it's the exact same instance of `File`. Other changes: - The internal storage of `File` objects inside a `Files` object has been reworked, so any plugins that choose to access `Files._files` will get a deprecation warning. - The order of `File` objects inside a `Files` collection is no longer significant when automatically inferring the `nav`. They get forcibly sorted according to the default alphabetic order. Context: [#3451](https://togithub.com/mkdocs/mkdocs/issues/3451), [#3463](https://togithub.com/mkdocs/mkdocs/issues/3463) #### Hooks and debugging - Hook files can now import adjacent \*.py files using the `import` statement. Previously this was possible to achieve only through a `sys.path` workaround. See the new mention in [documentation](https://www.mkdocs.org/user-guide/configuration/#hooks). Context: [#3568](https://togithub.com/mkdocs/mkdocs/issues/3568) - Verbose `-v` log shows the sequence of plugin events in more detail - shows each invoked plugin one by one, not only the event type. Context: [#3444](https://togithub.com/mkdocs/mkdocs/issues/3444) #### Deprecations - Python 3.7 is no longer supported, Python 3.12 is officially supported. Context: [#3429](https://togithub.com/mkdocs/mkdocs/issues/3429) - The theme config file `mkdocs_theme.yml` no longer executes YAML tags. Context: [#3465](https://togithub.com/mkdocs/mkdocs/issues/3465) - The plugin event `on_page_read_source` is soft-deprecated because there is always a better alternative to it (see the new `File` API or just `on_page_markdown`, depending on the desired interaction). When multiple plugins/hooks apply this event handler, they trample over each other, so now there is a warning in that case. See [**documentation**](https://www.mkdocs.org/dev-guide/plugins/#on_page_read_source). Context: [#3503](https://togithub.com/mkdocs/mkdocs/issues/3503) ##### API deprecations - It is no longer allowed to set `File.page` to a type other than `Page` or a subclass thereof. Context: [#3443](https://togithub.com/mkdocs/mkdocs/issues/3443) - following the deprecation in version 1.5.3 and [#3381](https://togithub.com/mkdocs/mkdocs/issues/3381). - `Theme._vars` is deprecated - use `theme['foo']` instead of `theme._vars['foo']` - `utils`: `modified_time()`, `get_html_path()`, `get_url_path()`, `is_html_file()`, `is_template_file()` are removed. `path_to_url()` is deprecated. - `LiveReloadServer.watch()` no longer accepts a custom callback. Context: [#3429](https://togithub.com/mkdocs/mkdocs/issues/3429) #### Misc - The `sitemap.xml.gz` file is slightly more reproducible and no longer changes on every build, but instead only once per day (upon a date change). Context: [#3460](https://togithub.com/mkdocs/mkdocs/issues/3460) Other small improvements; see [commit log](https://togithub.com/mkdocs/mkdocs/compare/1.5.3...1.6.0).timvink/mkdocs-git-revision-date-localized-plugin (mkdocs-git-revision-date-localized-plugin)
### [`v1.2.6`](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/releases/tag/v1.2.6): revision-date-localized v1.2.6 [Compare Source](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/compare/v1.2.5...v1.2.6) ##### What's Changed - Fix bitbucket CI warning showing up on github actions, by [@timvink](https://togithub.com/timvink) in [https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/issues/136](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/issues/136) **Full Changelog**: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/compare/v1.2.5...v1.2.6 ### [`v1.2.5`](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/releases/tag/v1.2.5): revision-date-localized v1.2.5 [Compare Source](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/compare/v1.2.4...v1.2.5) #### What's Changed - Fixing `_vars` deprecation warning by [@dbermuehler](https://togithub.com/dbermuehler) in [https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/132](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/132) #### New Contributors - [@dbermuehler](https://togithub.com/dbermuehler) made their first contribution in [https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/132](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/132) **Full Changelog**: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/compare/v1.2.4...v1.2.5 ### [`v1.2.4`](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/releases/tag/v1.2.4): revision-date-localized v1.2.4 [Compare Source](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/compare/v1.2.3...v1.2.4) - Revert jinja auto escape [#126](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/issues/126) **Full Changelog**: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/compare/v1.2.3...v1.2.4 ### [`v1.2.3`](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/releases/tag/v1.2.3): revision-date-localized v1.2.3 [Compare Source](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/compare/v1.2.2...v1.2.3) #### What's Changed - To prepare for next major mkdocs release: For jinja autoescape, mark HTML strings as safe, not needing escaping by [@oprypin](https://togithub.com/oprypin) in [https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/126](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/126) - Drop support for python 3.7 **Full Changelog**: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/compare/v1.2.2...v1.2.3 ### [`v1.2.2`](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/releases/tag/v1.2.2): revision-date-localized v1.2.2 [Compare Source](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/compare/v1.2.1...v1.2.2) #### What's Changed - Correctly check for truthiness of `generated_by` by [@oprypin](https://togithub.com/oprypin) in [https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/124](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/124) - \[fix] get locale for mkdocs-static-i18n by [@satisataka](https://togithub.com/satisataka) in [https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/125](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/125) #### New Contributors - [@oprypin](https://togithub.com/oprypin) made their first contribution in [https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/124](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/124) - [@satisataka](https://togithub.com/satisataka) made their first contribution in [https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/125](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/125) **Full Changelog**: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/compare/v1.2.1...v1.2.2 ### [`v1.2.1`](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/releases/tag/v1.2.1): revision-date-localized v1.2.1 [Compare Source](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/compare/v1.2.0...v1.2.1) #### What's Changed - Remove usage of `datetime.utcfromtimestamp` to avoid deprecated warnings in python 3.12 by [@timvink](https://togithub.com/timvink) in [https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/122](https://togithub.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/122) **Full Changelog**: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/compare/v1.2.0...v1.2.1Blueswen/mkdocs-glightbox (mkdocs-glightbox)
### [`v0.4.0`](https://togithub.com/blueswen/mkdocs-glightbox/releases/tag/v0.4.0): mkdocs-glightbox-0.4.0 [Compare Source](https://togithub.com/Blueswen/mkdocs-glightbox/compare/v0.3.7...v0.4.0) - Supported manual mode ([#29](https://togithub.com/Blueswen/mkdocs-glightbox/issues/29)) - Allow calling lightbox methods from other places ([#34](https://togithub.com/Blueswen/mkdocs-glightbox/issues/34)) - Added id to appended script tag ([#38](https://togithub.com/Blueswen/mkdocs-glightbox/issues/38)) - Access theme attribute directly ([#40](https://togithub.com/Blueswen/mkdocs-glightbox/issues/40)) - Better JavaScript Error Handling ([#36](https://togithub.com/Blueswen/mkdocs-glightbox/issues/36)) ### [`v0.3.7`](https://togithub.com/blueswen/mkdocs-glightbox/releases/tag/v0.3.7): mkdocs-glightbox-0.3.7 [Compare Source](https://togithub.com/Blueswen/mkdocs-glightbox/compare/v0.3.6...v0.3.7) - Supported custom background and shadow ([#27](https://togithub.com/Blueswen/mkdocs-glightbox/issues/27)) ### [`v0.3.6`](https://togithub.com/blueswen/mkdocs-glightbox/releases/tag/v0.3.6): mkdocs-glightbox-0.3.6 [Compare Source](https://togithub.com/Blueswen/mkdocs-glightbox/compare/v0.3.5...v0.3.6) - Modified width default to auto prevent zooming large image bug ([#21](https://togithub.com/Blueswen/mkdocs-glightbox/issues/21)) - Supported only enable glightbox with on-glb class in given page ([#28](https://togithub.com/Blueswen/mkdocs-glightbox/issues/28)) ### [`v0.3.5`](https://togithub.com/blueswen/mkdocs-glightbox/releases/tag/v0.3.5): mkdocs-glightbox-0.3.5 [Compare Source](https://togithub.com/Blueswen/mkdocs-glightbox/compare/v0.3.4...v0.3.5) - Supported compatibility with the privacy plugin of Material for MkDocs insiders ([#25](https://togithub.com/Blueswen/mkdocs-glightbox/issues/25))squidfunk/mkdocs-material (mkdocs-material)
### [`v9.5.28`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.28): mkdocs-material-9.5.28 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.27...9.5.28) - Fixed [#7313](https://togithub.com/squidfunk/mkdocs-material/issues/7313): Improved tooltips mounted in sidebar when feature is disabled ### [`v9.5.27`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.27): mkdocs-material-9.5.27 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.26...9.5.27) - Updated Estonian translations Thanks to [@Eilyre](https://togithub.com/Eilyre) for their contributions ### [`v9.5.26`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.26): mkdocs-material-9.5.26 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.25...9.5.26) - Fixed [#7232](https://togithub.com/squidfunk/mkdocs-material/issues/7232): Tab switches on scroll when linking tabs (9.5.19 regression) - Fixed [#7230](https://togithub.com/squidfunk/mkdocs-material/issues/7230): Blog author avatar broken when referring to local file ### [`v9.5.25`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.25): mkdocs-material-9.5.25 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.24...9.5.25) - Fixed [#7209](https://togithub.com/squidfunk/mkdocs-material/issues/7209): Tags plugin crashing on numeric tags ### [`v9.5.24`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.24): mkdocs-material-9.5.24 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.23...9.5.24) - Fixed [#7187](https://togithub.com/squidfunk/mkdocs-material/issues/7187): Version selector title rendering issue ### [`v9.5.23`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.23): mkdocs-material-9.5.23 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.22...9.5.23) - Fixed [#7183](https://togithub.com/squidfunk/mkdocs-material/issues/7183): Edge case in anchor navigation when using instant navigation - Fixed [#6436](https://togithub.com/squidfunk/mkdocs-material/issues/6436): Version selector not showing version alias ### [`v9.5.22`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.22): mkdocs-material-9.5.22 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.21...9.5.22) - Fixed [#7170](https://togithub.com/squidfunk/mkdocs-material/issues/7170): Copy button adds empty lines for line spans (9.5.18 regression) - Fixed [#7160](https://togithub.com/squidfunk/mkdocs-material/issues/7160): Version switching doesn't stay on page (9.5.5 regression) - Fixed [#5619](https://togithub.com/squidfunk/mkdocs-material/issues/5619): Links in Mermaid.js diagrams not discernible ### [`v9.5.21`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.21): mkdocs-material-9.5.21 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.20...9.5.21) - Fixed [#7133](https://togithub.com/squidfunk/mkdocs-material/issues/7133): Ensure latest version of Mermaid.js is used - Fixed [#7125](https://togithub.com/squidfunk/mkdocs-material/issues/7125): Added warning for dotfiles in info plugin Thanks to [@kamilkrzyskow](https://togithub.com/kamilkrzyskow) for their contributions ### [`v9.5.20`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.20): mkdocs-material-9.5.20 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.19...9.5.20) - Fixed deprecation warning in privacy plugin (9.5.19 regression) - Fixed [#7119](https://togithub.com/squidfunk/mkdocs-material/issues/7119): Tags plugin emits deprecation warning (9.5.19 regression) - Fixed [#7118](https://togithub.com/squidfunk/mkdocs-material/issues/7118): Social plugin crashes if fonts are disabled (9.5.19 regression) - Fixed [#7085](https://togithub.com/squidfunk/mkdocs-material/issues/7085): Social plugin crashes on Windows when downloading fonts ### [`v9.5.19`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.19): mkdocs-material-9.5.19 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.18...9.5.19) - Updated MkDocs to 1.6 and limited version to < 2 - Updated Docker image to latest Alpine Linux - Removed `setup.py`, now that GitHub fully understands `pyproject.toml` - Improved interop of social plugin with third-party MkDocs themes - Fixed [#7099](https://togithub.com/squidfunk/mkdocs-material/issues/7099): Blog reading time not rendered correctly for Japanese - Fixed [#7097](https://togithub.com/squidfunk/mkdocs-material/issues/7097): Improved resilience of tags plugin when no tags are given - Fixed [#7090](https://togithub.com/squidfunk/mkdocs-material/issues/7090): Active tab indicator in nested content tabs rendering bug ### [`v9.5.18`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.18): mkdocs-material-9.5.18 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.17...9.5.18) - Refactored tooltips implementation to fix positioning issues - Fixed [#7044](https://togithub.com/squidfunk/mkdocs-material/issues/7044): Rendering glitch when hovering contributor avatar in Chrome - Fixed [#7043](https://togithub.com/squidfunk/mkdocs-material/issues/7043): Highlighted lines in code blocks cutoff on mobile - Fixed [#6910](https://togithub.com/squidfunk/mkdocs-material/issues/6910): Incorrect position of tooltip for page status in sidebar - Fixed [#6760](https://togithub.com/squidfunk/mkdocs-material/issues/6760): Incorrect position and overly long tooltip in tables - Fixed [#6488](https://togithub.com/squidfunk/mkdocs-material/issues/6488): Incorrect position and cutoff tooltip in content tabs ### [`v9.5.17`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.17): mkdocs-material-9.5.17 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.16...9.5.17) - Updated Serbian translations - Fixed [#7003](https://togithub.com/squidfunk/mkdocs-material/issues/7003): Confusing keyboard interaction for palette toggle - Fixed [#7001](https://togithub.com/squidfunk/mkdocs-material/issues/7001): Blog posts now show time by default (9.5.16 regression) - Fixed edge case in backport of social plugin font loading logic Thanks to [@stcksmsh](https://togithub.com/stcksmsh) for their contributions. ### [`v9.5.16`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.16): mkdocs-material-9.5.16 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.15...9.5.16) - Updated Russian translations - Improved error handling and reporting in social plugin - Improved error handling and reporting in privacy plugin - Fixed blog plugin not allowing to use time in format strings - Fixed [#6983](https://togithub.com/squidfunk/mkdocs-material/issues/6983): Social plugin crashes because of Google Fonts API change Thanks to [@kamilkrzyskow](https://togithub.com/kamilkrzyskow), [@Guts](https://togithub.com/Guts), [@szg-alex-payne](https://togithub.com/szg-alex-payne) and [@natakazakova](https://togithub.com/natakazakova) for their contributions ### [`v9.5.15`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.15): mkdocs-material-9.5.15 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.14...9.5.15) - Reverted fix for transparent iframes (9.5.14) - Fixed [#6929](https://togithub.com/squidfunk/mkdocs-material/issues/6929): Interference of social plugin and auto dark mode - Fixed [#6938](https://togithub.com/squidfunk/mkdocs-material/issues/6938): Giscus shows dark background in light mode (9.5.14 regression) ### [`v9.5.14`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.14): mkdocs-material-9.5.14 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.13...9.5.14) - Added support for hiding versions from selector when using mike - Added init system to improve signal handling in Docker image - Fixed edge cases in exclusion logic of info plugin - Fixed inability to reset pipeline in search plugin - Fixed syntax error in Finnish translations - Fixed [#6917](https://togithub.com/squidfunk/mkdocs-material/issues/6917): UTF-8 encoding problems in blog plugin on Windows - Fixed [#6889](https://togithub.com/squidfunk/mkdocs-material/issues/6889): Transparent iframes get background color Thanks to [@kamilkrzyskow](https://togithub.com/kamilkrzyskow), [@yubiuser](https://togithub.com/yubiuser) and [@todeveni](https://togithub.com/todeveni) for their contributions ### [`v9.5.13`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.13): mkdocs-material-9.5.13 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.12...9.5.13) - Updated Slovak translations - Improved info plugin interop with projects plugin - Improved info plugin inclusion/exclusion logic - Fixed info plugin not gathering files recursively - Fixed [#6750](https://togithub.com/squidfunk/mkdocs-material/issues/6750): Ensure info plugin packs up all necessary files Thanks to [@kamilkrzyskow](https://togithub.com/kamilkrzyskow) and [@scepka](https://togithub.com/scepka) for their contributions ### [`v9.5.12`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.12): mkdocs-material-9.5.12 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.11...9.5.12) - Fixed [#6846](https://togithub.com/squidfunk/mkdocs-material/issues/6846): Some meta tags removed on instant navigation (9.4.2 regression) - Fixed [#6823](https://togithub.com/squidfunk/mkdocs-material/issues/6823): KaTex not rendering on instant navigation (9.5.5 regression) - Fixed [#6821](https://togithub.com/squidfunk/mkdocs-material/issues/6821): Privacy plugin doesn't handle URLs with encoded characters ### [`v9.5.11`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.11): mkdocs-material-9.5.11 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.10...9.5.11) - Updated Finnish translation ### [`v9.5.10`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.10): mkdocs-material-9.5.10 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.9...9.5.10) - Updated Bahasa Malaysia translations - Fixed [#6783](https://togithub.com/squidfunk/mkdocs-material/issues/6783): Hide continue reading link for blog posts without separators - Fixed [#6779](https://togithub.com/squidfunk/mkdocs-material/issues/6779): Incorrect positioning of integrated table of contents ### [`v9.5.9`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.9): mkdocs-material-9.5.9 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.8...9.5.9) - Fixed navigation pruning with tabs and sections enabled ### [`v9.5.8`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.8): mkdocs-material-9.5.8 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.7...9.5.8) - Added Tamil translations - Updated Esperanto translations - Fixed relative images not being resolved for instant navigation ### [`v9.5.7`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.7): mkdocs-material-9.5.7 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.6...9.5.7) - Fixed [#6731](https://togithub.com/squidfunk/mkdocs-material/issues/6731): Small images in figures are not centered - Fixed [#6719](https://togithub.com/squidfunk/mkdocs-material/issues/6719): Instant navigation breaks table of contents (9.5.5 regression) ### [`v9.5.6`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.6): mkdocs-material-9.5.6 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.5...9.5.6) - Fixed [#6700](https://togithub.com/squidfunk/mkdocs-material/issues/6700): Missing styles for Mermaid.js labels with Markdown ### [`v9.5.5`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.5): mkdocs-material-9.5.5 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.4...9.5.5) - Updated Tagalog translations - Updated Pillow to 10.2 to mitigate security vulnerabilities - Improved resilience of instant navigation - Fixed [#6687](https://togithub.com/squidfunk/mkdocs-material/issues/6687): Updated Mermaid.js to version 10.7.0 (latest) - Fixed [#6652](https://togithub.com/squidfunk/mkdocs-material/issues/6652): Keyboard events in custom elements captured - Fixed [#6582](https://togithub.com/squidfunk/mkdocs-material/issues/6582): Instant navigation doesn't correctly handle alternate URLs - Fixed [#6565](https://togithub.com/squidfunk/mkdocs-material/issues/6565): Instant navigation doesn't allow for `onclick` handlers - Fixed [#6345](https://togithub.com/squidfunk/mkdocs-material/issues/6345): Instant navigation sometimes breaks browser back button - Fixed [#6334](https://togithub.com/squidfunk/mkdocs-material/issues/6334): Instant navigation doesn't correctly position anchors (Safari) - Fixed [#6275](https://togithub.com/squidfunk/mkdocs-material/issues/6275): Instant navigation doesn't correctly resolve after 404 - Fixed [#6102](https://togithub.com/squidfunk/mkdocs-material/issues/6102): Instant navigation reloads page on same link navigation ### [`v9.5.4`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.4): mkdocs-material-9.5.4 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.3...9.5.4) - Fixed [#6645](https://togithub.com/squidfunk/mkdocs-material/issues/6645): Local storage with invalid value can break site - Fixed [#6635](https://togithub.com/squidfunk/mkdocs-material/issues/6635): Tags icons before default ignored if default is set ### [`v9.5.3`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.3): mkdocs-material-9.5.3 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.2...9.5.3) - Limited version range of MkDocs to < 1.6 - Updated Macedonian translations - Fixed [#6520](https://togithub.com/squidfunk/mkdocs-material/issues/6520): Group plugin crashes when using mike - Fixed [#6494](https://togithub.com/squidfunk/mkdocs-material/issues/6494): Hide author's email address if disabled in git-authors plugin ### [`v9.5.2`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.2): mkdocs-material-9.5.2 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.1...9.5.2) - Fixed types for `slugify` settings in blog plugin config - Fixed [#6469](https://togithub.com/squidfunk/mkdocs-material/issues/6469): Horizontal scrollbars on MathJax containers ### [`v9.5.1`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.1): mkdocs-material-9.5.1 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.5.0...9.5.1) - Updated Greek translations - Fixed [#6464](https://togithub.com/squidfunk/mkdocs-material/issues/6464): Privacy plugin cannot be enabled - Fixed [#6461](https://togithub.com/squidfunk/mkdocs-material/issues/6461): Sorting blog posts ignores time component in date ### [`v9.5.0`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.5.0): mkdocs-material-9.5.0 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.14...9.5.0) Merged Insiders features of 'Goat's Horn' funding goal - Added privacy plugin: automatic downloading of external assets - Added support for card grids and grid layouts - Added support for improved tooltips - Added support for content tabs anchor links (deep linking) - Added support for automatic dark/light mode - Added support for document contributors ### [`v9.4.14`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.14): mkdocs-material-9.4.14 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.13...9.4.14) - Added support for linking authors in blog posts ### [`v9.4.13`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.13): mkdocs-material-9.4.13 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.12...9.4.13) - Fixed [#6365](https://togithub.com/squidfunk/mkdocs-material/issues/6365): Blog plugin pagination links to previous pages broken - Fixed [#5758](https://togithub.com/squidfunk/mkdocs-material/issues/5758): Updated Mermaid.js to version 10.6.1 (latest) ### [`v9.4.12`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.12): mkdocs-material-9.4.12 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.11...9.4.12) - Improved blog plugin to generate Unicode-aware slugs by default - Fixed non-deterministic order of categories in blog plugin ### [`v9.4.11`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.11): mkdocs-material-9.4.11 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.10...9.4.11) - Fixed [#6364](https://togithub.com/squidfunk/mkdocs-material/issues/6364): Search plugin crashing when enabling theme while serving - Fixed blog plugin crashing when disabling pagination ### [`v9.4.10`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.10): mkdocs-material-9.4.10 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.9...9.4.10) - Fixed [#6356](https://togithub.com/squidfunk/mkdocs-material/issues/6356): Version selector can't be disabled via mike's configuration - Fixed [#6281](https://togithub.com/squidfunk/mkdocs-material/issues/6281): Navigation not rendering due to Safari bug (9.4.2 regression) - Fixed [#6261](https://togithub.com/squidfunk/mkdocs-material/issues/6261): Navigation expansion animates on first load (9.4.2 regression) ### [`v9.4.9`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.9): mkdocs-material-9.4.9 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.8...9.4.9) - Fixed [#6344](https://togithub.com/squidfunk/mkdocs-material/issues/6344): Long entries cutoff in table of contents - Fixed [#6336](https://togithub.com/squidfunk/mkdocs-material/issues/6336): Custom template for glob archive not working with pagination - Fixed [#6328](https://togithub.com/squidfunk/mkdocs-material/issues/6328): Blog plugin crashes for locales with dashes, e.g. `pt-BR` - Fixed [#6327](https://togithub.com/squidfunk/mkdocs-material/issues/6327): Copy-to-clipboard button doesn't trim trailing line feed - Fixed [#6302](https://togithub.com/squidfunk/mkdocs-material/issues/6302): Version strings not matched when using mike, only aliases - Fixed instant navigation progress indicator for gzipped content in Chrome - Fixed rendering bug on details marker rotation in Firefox ### [`v9.4.8`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.8): mkdocs-material-9.4.8 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.7...9.4.8) - Fixed invalid local address replacement when using instant loading - Fixed [#6275](https://togithub.com/squidfunk/mkdocs-material/issues/6275): Crash after navigation caused 404 when using instant loading ### [`v9.4.7`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.7): mkdocs-material-9.4.7 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.6...9.4.7) - Added Azerbaijani translations ### [`v9.4.6`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.6): mkdocs-material-9.4.6 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.5...9.4.6) - Updated Danish and Norwegian (Nynorsk) translations - Fixed [#6169](https://togithub.com/squidfunk/mkdocs-material/issues/6169): Blog post metadata layout overflows on small screensfacelessuser/mkdocs-material-extensions (mkdocs-material-extensions)
### [`v1.3.1`](https://togithub.com/facelessuser/mkdocs-material-extensions/blob/HEAD/changelog.md#131) [Compare Source](https://togithub.com/facelessuser/mkdocs-material-extensions/compare/1.3...1.3.1) - **FIX**: Better deprecation warning. ### [`v1.3`](https://togithub.com/facelessuser/mkdocs-material-extensions/blob/HEAD/changelog.md#131) [Compare Source](https://togithub.com/facelessuser/mkdocs-material-extensions/compare/1.2...1.3) - **FIX**: Better deprecation warning.Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Enabled.
â™» Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.
This PR has been generated by Mend Renovate. View repository job log here.