Skip to content

v6.0.0

Compare
Choose a tag to compare
@github-actions github-actions released this 11 Aug 01:01
· 40 commits to master since this release

⚠️ 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.