v7.0.0

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

Enhancements

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

v6.2.1

Bug fixes

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

v6.2.0

New features

• Add recursive argument to include-markdown directive.

Enhancements

• Apply substitutions from all directives at once. Improves performance in all includes and prevents big performance degradations including large contents in the same files of other includes.
• Warn when passing invalid arguments to directives. It could catches bad syntax, like trying to turning off comments in include directives (include does not provides a comments argument).

v6.1.1

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

New features

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

v6.0.7

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

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).