Mkdocs-include-markdown-plugin

Latest version: v6.0.6

Safety actively analyzes 625334 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 2 of 9

6.0.0

:warning: 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.
diff
- {% include-markdown "foo/bar.md" %}
+ {% include-markdown "./foo/bar.md" %}

- {% include-markdown "foo/*.md" %}
+ {% include-markdown "./foo/*.md" %}

- [`exclude`](https://github.com/mondeja/mkdocs-include-markdown-plugin/tree/v6.0.0#config_exclude) configuration setting added in [v5.1.0](https://github.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/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](https://facelessuser.github.io/wcmatch/glob/#syntax), allowing more flexible inclusions and exclusions, for example:
jinja
{% 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 `PluginError`s instead of `BuildError`s as recommended by Mkdocs.

5.1.0

New features

The next default values for arguments can be defined as settings:

- `start`
- `end`
- `exclude`
- `heading_offset`
- `rewrite_relative_urls`

Bug fixes

- Fixed error getting content from cache.
- Fixed detection of invalid `heading-offset` values.

Improvements

- Improved invalid values detection of boolean and integer arguments.

5.0.0

:warning: Breaking changes

- Drop Python 3.7 support.
- Drop Mkdocs < 1.4.0 support.

Enhancements

- Add support for Python 3.12.

New features

- Files to include can be now be URLs to include remote content.
- Added `cache` extra and setting to control HTTP requests persistent file caching.

Bug fixes

- Fix errors not producing a non zero exitcode when building.

4.0.4

Bug fixes:

- Fixed error using livereload server with Mkdocs < 1.4.0

4.0.3

Enhancements:

- Added some performance improvements.

4.0.2

Bug fixes:

- Fixed LiveReloadServer not imported at runtime with `serve` command (regression in 4.0.1)

Page 2 of 9

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.