Skip to content

Releases: mondeja/mkdocs-include-markdown-plugin

v7.1.6

13 Jun 18:25
1062404
Compare
Choose a tag to compare

Bug fixes

  • Fix internal anchor in included file incorrectly rewritten.

v7.1.5

07 Mar 23:28
aa17cc0
Compare
Choose a tag to compare

Bug fixes

  • Fix bug when warning about some invalid directive arguments.
  • Fix bug trying to use punctuations inside custom include directive names.

v7.1.4

09 Feb 14:30
253cbc4
Compare
Choose a tag to compare

Bug fixes

  • Fix internal anchors in included files not rewritten correctly.

v7.1.3

05 Feb 18:33
Compare
Choose a tag to compare

Enhancements

  • Add HTML support for relative URL rewrites.

v7.1.2

29 Nov 14:05
1ffebb2
Compare
Choose a tag to compare

Enhancements

  • Add cache_dir global setting to configure the path to the cache directory. When setted avoids the requirement to install platformdirs to use HTTP caching.

v7.1.1

21 Nov 05:28
Compare
Choose a tag to compare

New features

  • Add a new directives global setting to customize directive names.

Enhancements

  • Some performance optimizations.

v7.0.1

18 Nov 05:09
Compare
Choose a tag to compare

Enhancements

  • Performance optimization up to 25% faster.

v7.0.0

22 Oct 02:40
76f01cc
Compare
Choose a tag to compare

Breaking changes

No longer installable on Python v3.8

Minimum Python version for installation is v3.9. Python v3.8 reached his end of life at 2024-10-07.

Comments are turned off by default

Before this release, the default value for comments argument of include-markdown directive was true. Now has been switched to false. This prevents some inconvenients, for example, trying to include one-line texts on table cells and list items.

If you want the previous behaviour, configure comments as true in the global configuration:

plugins:
  - include-markdown:
      comments: true

Indented code blocks must be surrounded by newlines

Now mkdocs-include-markdown-plugin will only detect indented code blocks if are surrounded by newlines, conforming to CommonMark specification.

In the practice this means that you must surround indented code blocks with newlines or possible link targets URLs will be rewritten to work in relative files. For example, the next code is not treated as an indented code block any more and will break:

Foo
    const auto lambda = []() { .... };

v6.2.2

10 Aug 23:36
c1db293
Compare
Choose a tag to compare

Enhancements

  • Add official support for Python v3.13.
  • Relax wcmatch dependency.

v6.2.1

21 Jun 17:11
0fd1119
Compare
Choose a tag to compare

Bug fixes

  • Improve performance of inclusion regex processing. Prevents to take a lot of time parsing long lines looking for inclusions.