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: trueIndented 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 = []() { .... };