Version 1.6.1 (Friday 30th August, 2024) Fixed Fix build error when environment variable SOURCE_DATE_EPOCH=0 is set. #3795 Fix build error when mkdocs_theme.yml config is empty. #3700 Support python -W and PYTHONWARNINGS instead of overriding the configuration. #3809 Support running with Docker under strict mode, by removing 0.0.0.0 dev server warning. #3784 Drop unnecessary changefreq from sitema…
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 New flag serve --open to open the site in a browser. After the first build is finished, this flag wil…
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 (#3370) Plugins ca…
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). Plugins should be free…
Bugfix (regression in 1.5.0): Make it possible to treat ExtraScriptValue as a path. This lets some plugins still work despite the breaking change. Bugfix (regression in 1.5.0): Prevent errors for special setups that have 3 conflicting files, such as index.html, index.md and README.md (#3314) See commit log.
New: MkDocs now accepts donations. Please consider supporting the current maintainer at my new GitHub sponsorship page. MkDocs has been a totally free project since the beginning and wasn't accepting funds. MkDocs will remain free of paywalls, but now you can show your support with donations (one-time and/or recurring). Donate for MkDocs - @oprypin sponsors page And please also consider these othe…
Bugfix: for the hooks feature, modules no longer fail to load if using some advanced Python features like dataclasses (#3193) Bugfix: Don't create None sitemap entries if the page has no populated URL - affects sites that exclude some files from navigation (07a297b) "readthedocs" theme: Accessibility: add aria labels to Home logo (#3129) and search inputs (#3046) "readthedocs" theme now supports h…
Officially support Python 3.11 (#3020) Note: Simply upgrading to Python 3.11 can cut off 10-15% of your site's build time. Support multiple instances of the same plugin (#3027) If a plugin is specified multiple times in the list under the plugins: config, that will create 2 (or more) instances of the plugin with their own config each. Previously this case was unforeseen and, as such, bugged. Now e…
Support theme-namespaced plugin loading (#2998) Plugins' entry points can be named as 'sometheme/someplugin'. That will have the following outcome: If the current theme is 'sometheme', the plugin 'sometheme/someplugin' will always be preferred over 'someplugin'. If the current theme isn't 'sometheme', the only way to use this plugin is by specifying plugins: [sometheme/someplugin]. One can also sp…
Feature upgrades Hooks (#2978) The new hooks: config allows you to add plugin-like event handlers from local Python files, without needing to set up and install an actual plugin. See documentation. edit_uri flexibility (#2927) There is a new edit_uri_template: config. It works like edit_uri but more generally covers ways to construct an edit URL. See documentation. Additionally, the edit_uri funct…