Skip to content

Commit

Permalink
Release 1.5.3 (#3392)
Browse files Browse the repository at this point in the history
  • Loading branch information
oprypin committed Sep 18, 2023
1 parent 63b5045 commit 00b648f
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
18 changes: 17 additions & 1 deletion docs/about/release-notes.md
Expand Up @@ -27,13 +27,29 @@ The current and past members of the MkDocs team.
* [@oprypin](https://github.com/oprypin/)
* [@ultrabug](https://github.com/ultrabug/)

## Version 1.5.3 (2023-09-18)

* Fix `mkdocs serve` sometimes locking up all browser tabs when navigating quickly (#3390)

* Add many new supported languages for "search" plugin - update lunr-languages to 1.12.0 (#3334)

* Bugfix (regression in 1.5.0): In "readthedocs" theme the styling of "breadcrumb navigation" was broken for nested pages (#3383)

* Built-in themes now also support Chinese (Traditional, Taiwan) language (#3154)

* Plugins can now set `File.page` to their own subclass of `Page`. There is also now a warning if `File.page` is set to anything other than a strict subclass of `Page`. (#3367, #3381)

Note that just instantiating a `Page` [sets the file automatically](https://github.com/mkdocs/mkdocs/blob/f94ab3f62d0416d484d81a0c695c8ca86ab3b975/mkdocs/structure/pages.py#L34), so care needs to be taken not to create an unneeded `Page`.

Other small improvements; see [commit log](https://github.com/mkdocs/mkdocs/compare/1.5.2...1.5.3).

## Version 1.5.2 (2023-08-02)

* Bugfix (regression in 1.5.0): Restore functionality of `--no-livereload`. (#3320)

* Bugfix (regression in 1.5.0): The new page title detection would sometimes be unable to drop anchorlinks - fix that. (#3325)

* Partly bring back pre-1.5 API: `extra_javascript` items will once again be mostly strings, and only sometimes `ExtraStringValue` (when the extra `script` functionality is used).
* Partly bring back pre-1.5 API: `extra_javascript` items will once again be mostly strings, and only sometimes `ExtraScriptValue` (when the extra `script` functionality is used).

Plugins should be free to append strings to `config.extra_javascript`, but when reading the values, they must still make sure to read it as `str(value)` in case it is an `ExtraScriptValue` item. For querying the attributes such as `.type` you need to check `isinstance` first. Static type checking will guide you in that. (#3324)

Expand Down
2 changes: 1 addition & 1 deletion mkdocs/__init__.py
Expand Up @@ -2,4 +2,4 @@


# For acceptable version formats, see https://www.python.org/dev/peps/pep-0440/
__version__ = '1.5.2'
__version__ = '1.5.3'

0 comments on commit 00b648f

Please sign in to comment.