Changelog#

All notable changes to this project will be documented in this file.

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

1.1.0 - 2022-04-27#

Changed#

  • switched license to MIT. (See #117)

1.0.0 - 2022-03-31#

First stable release according to semver.
So, no feature in this release, just focusing on quality and code cleanliness.

Added#

  • Unit tests to reach a 80% coverage score

Changed#

  • Supported Mkdocs versions range increased to mkdocs>=1.1,<1.4

Fixed#

  • Minor bugs fixes
  • Minor documentation improvments

0.21.0 - 2022-02-10#

Added#

  • JSON Schema for configuration validation
  • compatible with Python 3.10

0.20.1 - 2022-02-08#

Fixed#

  • Error when using "enabled: false" together with "match_path" (see #104 - PR #107). Reported by @prcr, fixed by @dcode. Thanks to them!

0.20.0 - 2022-01-06#

Added#

  • option to enable/disable the plugin, for example through an environment variable (default: enabled). See: PR #103, related doc section

Changed#

  • CI: Python version used to build and publish package is now 3.9

Removed#

  • support for Python 3.6 (EOL)

0.19.1 - 2021-10-04#

Fixed#

  • Fix #95: introduced logic did not handle case where categories meta keys are not defined

0.19.0 - 2021-10-02#

Added#

  • new option to include RSS <category> item element using page metadata (YAML frontmatter). It's customizable to get custom meta keys for keywords/tags. PR #4

0.18.0 - 2021-09-20#

Added#

Changed#

  • documentation on ReadTheDocs has been removed to reduce confusion and dependencies. PR #89.

0.17.0 - 2021-06-14#

Changed#

  • bump MkDocs maximal version

Fixed#

  • improve DockerFile used to test, fixing it after Material removed some dependencies

0.16.1#

Fixed#

  • remove a print statement

0.16.0#

Added#

Changed#

  • ignore urllib.error.URLError exception to avoid build crashes typically when network is offline

0.15.0#

Added#

  • ability to define URL parameters on items URLs (see documentation)
  • complete unit tests and display code coverage badge (using codecov.io)

Changed#

  • homogenization of docstrings on the sphinx format (as stipulated in the contribution guidelines)

0.14.0#

Fixed#

  • fix match_path option by skipping the pages that aren't included. See PR #49. Contributed by Paulo Ribeiro.

Added#

  • add isort to development toolbelt

0.13.0#

Added#

  • if page.meta.description is not set, the abstract_chars_count first characters from markdown content are now converted into HTML.
  • add match_path option which should be a regex pattern matching the path to your files within the docs_dir. See issue #34 and the related PR #43. Contributed by Ryan Morshead.

0.12.0#

Added#

  • add support to page.meta.authors or page.meta.author to populate feed items author tag. See issue #34.

0.11.0#

Added#

Changed#

  • By default, the output file is now minified.

0.10.0#

Added#

  • option to use dates from page metadata (YAML front-matter) instead of git log. See #14 and related documentation section
  • Python 3.9 is enabled in CI and referenced in PyPi tags

Changed#

  • the default length for description has been changed from 150 to 160 to fit maximum recommendation

0.9.0#

Improved#

  • enable auto-escape on feed and item titles, using the Jinja e filter - see #19
  • improve consistency for missing attributes in mkdocs.yml, returning almost always a None value

0.8.0#

Added#

  • RSS compliance: image length is now present into enclosure tags - See #9
  • User documentation:
  • clarify how item elements are computed
  • add how to edit HTML templates meta-tags to reference feeds
  • API reference documentation generated from source code and published through Read The Docs

0.7.2#

Fixed#

  • wrong items order in updated feed

0.7.1#

Fixed#

  • feed for updated content is broken - #15

0.7.0#

Added#

  • plugin: add the language tag to the channel
  • tooling:
  • add first unit tests and code coverage
  • add Github Action to perform tests
  • check docker build using mkdocs-material

Changed#

  • docs: switch Feedly images from HTTP to HTTPS

0.6.1#

Fixed#

  • remove print from plugin code

0.6.0#

Added#

  • plugin: add tag guid to the feed's items (using the page URL)

Changed#

  • docs: minor improvments

0.5.0#

Added#

  • plugin: handle channel image and items (entries) enclosure

Changed#

  • plugin: refactoring to build feed entry through a method