Skip to content

Bump mkdocs from 1.4.3 to 1.5.1

HIFIS Bot requested to merge dependabot-pip-mkdocs-1.5.1 into master

Bumps mkdocs from 1.4.3 to 1.5.1.

Release notes

Sourced from mkdocs's releases.

1.5.1

  • 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.

1.5.0

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 other individuals who have been contributing to the ecosystem for a long time and check out their donations pages:

@​facelessuser @​pawamoy @​Ultrabug


Release 1.5.0

New command mkdocs get-deps

This command guesses the Python dependencies that a MkDocs site requires in order to build. It simply prints the PyPI packages that need to be installed. In the terminal it can be combined directly with an installation command as follows:

pip install $(mkdocs get-deps)

The idea is that right after running this command, you can directly follow it up with mkdocs build and it will almost always "just work", without needing to think which dependencies to install.

The way it works is by scanning mkdocs.yml for themes:, plugins:, markdown_extensions: items and doing a reverse lookup based on a large list of known projects (catalog, see below).

Of course, you're welcome to use a "virtualenv" with such a command. Also note that for environments that require stability (for example CI) directly installing deps in this way is not a very reliable approach as it precludes dependency pinning.

The command allows overriding which config file is used (instead of mkdocs.yml in the current directory) as well as which catalog of projects is used (instead of downloading it from the default location). See mkdocs get-deps --help.

Context: #3205

MkDocs has an official catalog of plugins

Check out https://github.com/mkdocs/catalog and add all your general-purpose plugins, themes and extensions there, so that they can be looked up through mkdocs get-deps.

This was renamed from "best-of-mkdocs" and received significant updates. In addition to pip installation commands, the page now shows the config boilerplate needed to add a plugin.

Expanded validation of links

... (truncated)

Commits
  • 2865b0f Release 1.5.1 (#3315)
  • ea549e6 Make it possible to treat ExtraScriptValue as a path
  • 86cde7b Catch ValueErrors thrown when attempting to remove a file twice (#3314)
  • 0d9e341 Release 1.5.0 (#3296)
  • 0f8ab6b Fix livereload shutdown sequence - crash on Windows
  • bfb52a3 Create FUNDING.yml (#3295)
  • 189faf0 Merge pull request #3297 from mkdocs/regr
  • bb00d4c Add a test for relative link without dot in filename
  • c3d4ff7 Fix unescaping of Markdown titles
  • d8bc90f Always set inclusion_level so static-i18n plugin keeps working
  • Additional commits viewable in compare view

Merge request reports

Loading