v6.0.6

Bug fixes

• Fixed errors when using Mkdocs>=1.6.0 generated files (#205). Now if you try to include using a relative path from a generated file, an error will be raised.

v6.0.5

Bug fixes

• Fixed default setting heading_offset not being applied.

v6.0.4

Bug fixes

• Fixed logging variables not included formatting messages (regression from v6.0.2).

v6.0.3

Enhancements

• Add mkdocs>=1.4 as dependency.

v6.0.2

Enhancements

• Dropped Python upper version requirement bound.

v6.0.1

Bug fixes

• Fixed some warnings not shown when missing start and end delimiters in some contexts (regression from v6.0.0).

v6.0.0

⚠️ Breaking changes

• Inclusion and exclusion relative paths and globs must start with ./ or ../. Non-explicit relative paths (like foo/bar.md) will be treated as relative to docs_dir (typically the docs/ directory). To migrate just prepend ./ in all your implicit relative paths and globs.

  - {% include-markdown "foo/bar.md" %}
  + {% include-markdown "./foo/bar.md" %}
  
  - {% include-markdown "foo/*.md" %}
  + {% include-markdown "./foo/*.md" %}

• exclude configuration setting added in v5.1.0 is not treated more as a default value for the exclude argument. Now accepts an array that defines multiple global exclusion patterns that will extend the exclude argument pattern matches. Relative paths used by the exclude global setting will be treated as relatives to docs_dir.

New features

• Includer and excluder globs now accept Bash-style wildcard patterns, allowing more flexible inclusions and exclusions, for example:

  {% include-markdown "**" exclude="./{index,LICENSE}.md" %}

• Allow to define paths and globs relative to docs/ directory for inclusions and exclusions with implicit relative paths like foo/bar.md or index.md.

Enhancements

• Raise PluginErrors instead of BuildErrors as recommended by Mkdocs.

v5.1.0

New features

The next default values for arguments can be defined as settings:

• start
• end
• exclude
• heading_offset
• rewrite_relative_urls

Bug fixes

• Fixed error getting content from cache.
• Fixed detection of invalid heading-offset values.

Improvements

• Improved invalid values detection of boolean and integer arguments.

v5.0.0

⚠️ Breaking changes

• Drop Python 3.7 support.
• Drop Mkdocs < 1.4.0 support.

Enhancements

• Add support for Python 3.12.

New features

• Files to include can be now be URLs to include remote content.
• Added cache extra and setting to control HTTP requests persistent file caching.

Bug fixes

• Fix errors not producing a non zero exitcode when building.

v4.0.4

Bug fixes:

• Fixed error using livereload server with Mkdocs < 1.4.0