Change log

This file lists all updates to the mkdocs-meta-descriptions plugin.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

v3.0.0 (2023-12-06)

Added

Added support for Python 3.12.

Removed

Dropped support for Python 3.7 after reaching EOL on 2023-06-27.

v2.3.0 (2023-07-31)

Added

New option trim to trim meta descriptions coming from the first paragraph of the pages to include at most max_length characters. Fixes #259. Thanks to @mur4d1n for the contribution! 🎉

Changed

If you're using MkDocs>=1.5.0, the log messages produced by the plugin have the prefix meta-descriptions: instead of [meta-descriptions] since the plugin now uses the built-in MkDocs logger to help format log messages consistently across plugins.

v2.2.0 (2022-12-15)

Added

Added support for Python 3.11.

v2.1.0 (2022-10-01)

Added

New option enable_checks to validate if all pages have meta descriptions and if each meta description has the recommended length.

v2.0.0 (2022-07-23)

Added

Added support for Python 3.10.
New option quiet to stop info messages from being displayed on the console when running MkDocs.
New debug messages to log which meta description the plugin used on each page, available by running MkDocs with the --verbose flag.

Changed

Tweaked existing console log messages.

Removed

Dropped support for Python 3.6 after reaching EOL on 2021-12-23.

v1.0.2 (2021-09-12)

Fixed

Ignore first paragraphs if they belong to an Admonition card. Fixes #95.

v1.0.1 (2021-05-16)

Fixed

Write full page URLs in meta-descriptions.csv if site_url is defined. Fixes #68.
Drop lxml dependency by using Python's built-in html.parser instead

v1.0.0 (2021-05-15)

First stable version.

Added

Support for exporting meta descriptions as CSV file.

v0.0.5 (2021-05-10)

Fixed

Slacken minimum requirements for Python packages to make the plugin compatible with a wider range of environments.

v0.0.4 (2021-04-27)

Fixed

Correct package name in setup.py that was preventing the plugin from being used in MkDocs.

v0.0.3 (2021-04-24)

Fixed

Escape special characters & < " ' > in text used in meta descriptions. Fixes #35.

v0.0.2 (2021-04-06)

First working version with documentation.