Skip to content

Update mkdocs to 1.3.1#313

Closed
pyup-bot wants to merge 1 commit intomasterfrom
pyup-update-mkdocs-1.1.2-to-1.3.1
Closed

Update mkdocs to 1.3.1#313
pyup-bot wants to merge 1 commit intomasterfrom
pyup-update-mkdocs-1.1.2-to-1.3.1

Conversation

@pyup-bot
Copy link
Copy Markdown
Collaborator

This PR updates mkdocs from 1.1.2 to 1.3.1.

Changelog

1.3.1

* Pin Python-Markdown version to <3.4, thus excluding its latest release that breaks too many external extensions (2893)

* When a Markdown extension fails to load, print its name and traceback (2894)

* Bugfix for "readthedocs" theme (regression in 1.3.0): add missing space in breadcrumbs (2810)

* Bugfix: don't complain when a file "readme.md" (lowercase) exists, it's not recognized otherwise (2852)

* Built-in themes now also support these languages:
 * Italian (2860)

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

1.3.0

Feature upgrades

* ReadTheDocs theme updated from v0.4.1 to v1.0.0 according to upstream (2585)

 The most notable changes:

 * New option `logo`: Rather than displaying the `site_name` in the title, one can specify a path to an image to display instead.
 * New option `anonymize_ip` for Google Analytics.
 * Dependencies were upgraded: jQuery upgraded to 3.6.0, Modernizr.js dropped, and others.

 See [documentation of config options for the theme](https://www.mkdocs.org/user-guide/choosing-your-theme/#readthedocs)

* Built-in themes now also support these languages:
 * German (2633)
 * Persian (Farsi) (2787)

* Support custom directories to watch when running `mkdocs serve` (2642)

 MkDocs by default watches the *docs* directory and the config file. Now there is a way to add more directories to watch for changes, either via the YAML `watch` key or the command line flag `--watch`.

 Normally MkDocs never reaches into any other directories (so this feature shouldn't be necessary), but some plugins and extensions may do so.

 See [documentation](https://www.mkdocs.org/user-guide/configuration/#watch).

* New `--no-history` option for `gh_deploy` (2594)

 Allows to discard the history of commits when deploying, and instead replace it with one root commit

Bug fixes

* An XSS vulnerability when using the search function in built-in themes was fixed (2791)

* Setting the `edit_uri` option no longer erroneously adds a trailing slash to `repo_url` (2733)

Miscellaneous

* Breaking change: the `pages` config option that was deprecated for a very long time now causes an error when used (2652)

 To fix the error, just change from `pages` to `nav`.

* Performance optimization: during startup of MkDocs, code and dependencies of other commands will not be imported (2714)

 The most visible effect of this is that dependencies of `mkdocs serve` will not be imported when `mkdocs build` is used.

* Recursively validate `nav` (2680)

 Validation of the nested `nav` structure has been reworked to report errors early and reliably. Some [edge cases](https://github.com/mkdocs/mkdocs/blob/b7272150bbc9bf8f66c878f6517742de3528972b/mkdocs/tests/config/config_options_tests.py#L783) have been declared invalid.

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

1.2.4

* Compatibility with Jinja2 3.1.0 (2800)

 Due to a breaking change in Jinja2, MkDocs would crash with the message `AttributeError: module 'jinja2' has no attribute 'contextfilter'`

1.2.3

MkDocs 1.2.3 is a bugfix release for [MkDocs 1.2](https://www.mkdocs.org/about/release-notes/#version-12-2021-06-04).

*Aside*: MkDocs has a new [chat room](https://gitter.im/mkdocs/community) on Gitter/Matrix. [More details](https://github.com/mkdocs/mkdocs#support).

Improvements:

* Built-in themes now also support these languages:
 * Simplified Chinese (2497)
 * Japanese (2525)
 * Brazilian Portuguese (2535)
 * Spanish (2545, previously 2396)

* Third-party plugins will take precedence over built-in plugins with the same name (2591)

* Bugfix: Fix ability to load translations for some languages: core support (2565) and search plugin support with fallbacks (2602)

* Bugfix (regression in 1.2): Prevent directory traversal in the dev server (2604)

* Bugfix (regression in 1.2): Prevent webserver warnings from being treated as a build failure in strict mode (2607)

* Bugfix: Correctly print colorful messages in the terminal on Windows (2606)

* Bugfix: Python version 3.10 was displayed incorrectly in `--version` (2618)

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

1.2.2

MkDocs 1.2.2 is a bugfix release for [MkDocs 1.2](https://www.mkdocs.org/about/release-notes/#version-12-2021-06-04) -- make sure you've seen the "major" release notes as well.

* Bugfix (regression in 1.2): Fix serving files/paths with Unicode characters (2464)

* Bugfix (regression in 1.2): Revert livereload file watching to use polling observer (2477)

 This had to be done to reasonably support usages that span virtual filesystems such as non-native Docker and network mounts.

 This goes back to the polling approach, very similar to that was always used prior, meaning most of the same downsides with latency and CPU usage.

* Revert from 1.2: Remove the requirement of a `site_url` config and the restriction on `use_directory_urls` (2490)

* Bugfix (regression in 1.2): Don't require trailing slash in the URL when serving a directory index in `mkdocs serve` server (2507)

 Instead of showing a 404 error, detect if it's a directory and redirect to a path with a trailing slash added, like before.

* Bugfix: Fix `gh_deploy` with config-file in the current directory (2481)

* Bugfix: Fix reversed breadcrumbs in "readthedocs" theme (2179)

* Allow "mkdocs.yaml" as the file name when '--config' is not passed (2478)

* Stop treating ";" as a special character in URLs: urlparse -> urlsplit (2502)

* Improve build performance for sites with many pages (partly already done in 1.2) (2407)
Links

@pyup-bot
Copy link
Copy Markdown
Collaborator Author

Closing this in favor of #330

@pyup-bot pyup-bot closed this Sep 27, 2022
@mgurdal mgurdal deleted the pyup-update-mkdocs-1.1.2-to-1.3.1 branch September 27, 2022 18:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant