Releases: mondeja/mkdocs-include-markdown-plugin
Releases · mondeja/mkdocs-include-markdown-plugin
v6.1.1
v6.1.0
New features
- Add a new
recursive
argument to theinclude
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
v6.0.5
Bug fixes
- Fixed default setting
heading_offset
not being applied.
v6.0.4
v6.0.3
Enhancements
- Add
mkdocs>=1.4
as dependency.
v6.0.2
Enhancements
- Dropped Python upper version requirement bound.
v6.0.1
v6.0.0
⚠️ Breaking changes
- Inclusion and exclusion relative paths and globs must start with
./
or../
. Non-explicit relative paths (likefoo/bar.md
) will be treated as relative todocs_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 theexclude
argument. Now accepts an array that defines multiple global exclusion patterns that will extend theexclude
argument pattern matches. Relative paths used by theexclude
global setting will be treated as relatives todocs_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
orindex.md
.
Enhancements
- Raise
PluginError
s instead ofBuildError
s as recommended by Mkdocs.