Skip to content

Releases: mondeja/mkdocs-include-markdown-plugin

v6.1.1

01 Jun 21:16
0abce62
Compare
Choose a tag to compare

Enhancements

  • Change substitions order of directives. Prevents performance degradations when including long files with include directive in the same file with other include-markdown directive.

v6.1.0

01 Jun 15:37
47f57fb
Compare
Choose a tag to compare

New features

  • Add a new recursive argument to the include directive that allows to stop recursively processing includes in included files.

v6.0.7

29 May 20:28
eb65645
Compare
Choose a tag to compare

Bug fixes

  • Fix error message on Windows when a file that is not inside the same drive of the docs_dir directory is not found.

v6.0.6

02 May 00:45
73867ab
Compare
Choose a tag to compare

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

25 Mar 06:50
Compare
Choose a tag to compare

Bug fixes

  • Fixed default setting heading_offset not being applied.

v6.0.4

10 Nov 21:12
1690934
Compare
Choose a tag to compare

Bug fixes

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

v6.0.3

14 Oct 20:16
b1eef73
Compare
Choose a tag to compare

Enhancements

  • Add mkdocs>=1.4 as dependency.

v6.0.2

12 Oct 17:53
6108b10
Compare
Choose a tag to compare

Enhancements

  • Dropped Python upper version requirement bound.

v6.0.1

31 Aug 18:58
6772c50
Compare
Choose a tag to compare

Bug fixes

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

v6.0.0

11 Aug 01:01
Compare
Choose a tag to compare

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