mondeja/mkdocs-include-markdown-plugin (mkdocs-include-markdown-plugin)
### [`v5.1.0`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v5.1.0)
[Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v5.0.0...v5.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.
### [`v5.0.0`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v5.0.0)
[Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v4.0.4...v5.0.0)
#### 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.
### [`v4.0.4`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v4.0.4)
[Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v4.0.3...v4.0.4)
Bug fixes:
- Fixed error using livereload server with Mkdocs < 1.4.0
### [`v4.0.3`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v4.0.3)
[Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v4.0.2...v4.0.3)
Enhancements:
- Added some performance improvements.
### [`v4.0.2`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v4.0.2)
[Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v4.0.1...v4.0.2)
Bug fixes:
- Fixed LiveReloadServer not imported at runtime with `serve` command (regression in 4.0.1)
### [`v4.0.1`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v4.0.1)
[Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v4.0.0...v4.0.1)
Enhancements:
- The plugin has been fully typed.
Bug fixes:
- Prevented an edge case bug when specifying an invalid encoding parameter in directives.
### [`v4.0.0`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v4.0.0)
[Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v3.9.1...v4.0.0)
:warning: Breaking changes:
- The plugin is no longer installable on Python 3.6.
### [`v3.9.1`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v3.9.1)
[Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v3.9.0...v3.9.1)
Bug fixes:
- Fixed event order on Mkdocs >= 1.4.0
### [`v3.9.0`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v3.9.0)
[Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v3.8.1...v3.9.0)
New features:
- Included files are watched when using `mkdocs serve`. Only supported from Mkdocs v1.4.0 onwards.
Deprecated:
- The support for Python 3.6 has been oficially deprecated and the plugin will not be installable on that version from the next v4.0.0 release.
### [`v3.8.1`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v3.8.1)
[Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v3.8.0...v3.8.1)
Bug fixes:
- Fixed two errors relative to includer indentation for both directives.
### [`v3.8.0`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v3.8.0)
[Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v3.7.1...v3.8.0)
New features:
- Allow to configure globally some arguments passed to directives, see [Configuration π](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/tree/v3.8.0#configuration)
### [`v3.7.1`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v3.7.1)
[Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v3.7.0...v3.7.1)
Bug fixes:
- HTML-escape file paths in comments generated by `include-markdown` directive to prevent broken content when including some edge cases.
### [`v3.7.0`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v3.7.0)
[Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v3.6.1...v3.7.0)
New features:
- Added new argument `encoding` for both directives.
### [`v3.6.1`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v3.6.1)
[Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v3.6.0...v3.6.1)
Bug fixes:
- Wrap `start` and `end` delimiters contents by single quotes in comments to show them better.
### [`v3.6.0`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v3.6.0)
[Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v3.5.2...v3.6.0)
New features:
- Allow to configure globally custom tags strings to open and close directives ([#112](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/issues/112)).
### [`v3.5.2`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v3.5.2)
[Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v3.5.1...v3.5.2)
Bug fixes:
- Fixed incompatibility between `trailing-newlines` and `comments` arguments of `include-markdown` directive.
### [`v3.5.1`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v3.5.1)
[Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v3.5.0...v3.5.1)
Bug fixes:
- Fixed nested inclusions showing incorrect warning messages.
- Fixed error skipping relative URLs rewriting in indented codeblocks using Windows newlines.
Enhancements:
- Allow to pass string arguments wrapped by single quotes `'` escaping them with `\'`.
- Show errors if `filename`, `end`, `start` or `exclude` arguments are empty.
- Show error rather than raising an exception if a file to be included is not found.
- Show error rather than raising an exception if a parsed boolean value is not valid.
- Improved warning messages adding affected line number and directive.
### [`v3.5.0`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v3.5.0)
[Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v3.4.1...v3.5.0)
New features:
- New option [`trailing-newlines`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/tree/1859d0008da744666343a0da0c1bcf8e408858f8#include-markdown_trailing-newlines) for both directives to strip trailing newlines from content to include.
- Both directives accept now recursive `**` wildcard globbing to match against subdirectories including multiple files.
Enhancements:
- String arguments `filename`, `start`, `end` and `exclude` now accept double quotes `"` in values escaping them with `\"`.
### [`v3.4.1`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v3.4.1)
[Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v3.4.0...v3.4.1)
Bug fixes:
- Fixed offset application not skipped in codeblocks at nested Markdown blocks.
- Fixed incorrect output skipping relative URL rewritings in indented codeblocks.
Enhancements:
- Optimize migrating from `pathlib` to `os.path`.
- Some tiny performance optimizations processing text.
### [`v3.4.0`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v3.4.0)
[Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v3.3.0...v3.4.0)
Enhancements:
- Warn if `end` or `start` arguments are not detected inside content to include.
Configuration
π Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
π¦ Automerge: Disabled by config. Please merge this manually once you are satisfied.
β» Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
π Ignore: Close this PR and you won't be reminded about this update again.
[ ] If you want to rebase/retry this PR, check this box
This PR has been generated by Mend Renovate. View repository job log here.
This PR contains the following updates:
==3.3.0
->==5.1.0
Release Notes
mondeja/mkdocs-include-markdown-plugin (mkdocs-include-markdown-plugin)
### [`v5.1.0`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v5.1.0) [Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v5.0.0...v5.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. ### [`v5.0.0`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v5.0.0) [Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v4.0.4...v5.0.0) #### 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. ### [`v4.0.4`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v4.0.4) [Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v4.0.3...v4.0.4) Bug fixes: - Fixed error using livereload server with Mkdocs < 1.4.0 ### [`v4.0.3`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v4.0.3) [Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v4.0.2...v4.0.3) Enhancements: - Added some performance improvements. ### [`v4.0.2`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v4.0.2) [Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v4.0.1...v4.0.2) Bug fixes: - Fixed LiveReloadServer not imported at runtime with `serve` command (regression in 4.0.1) ### [`v4.0.1`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v4.0.1) [Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v4.0.0...v4.0.1) Enhancements: - The plugin has been fully typed. Bug fixes: - Prevented an edge case bug when specifying an invalid encoding parameter in directives. ### [`v4.0.0`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v4.0.0) [Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v3.9.1...v4.0.0) :warning: Breaking changes: - The plugin is no longer installable on Python 3.6. ### [`v3.9.1`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v3.9.1) [Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v3.9.0...v3.9.1) Bug fixes: - Fixed event order on Mkdocs >= 1.4.0 ### [`v3.9.0`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v3.9.0) [Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v3.8.1...v3.9.0) New features: - Included files are watched when using `mkdocs serve`. Only supported from Mkdocs v1.4.0 onwards. Deprecated: - The support for Python 3.6 has been oficially deprecated and the plugin will not be installable on that version from the next v4.0.0 release. ### [`v3.8.1`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v3.8.1) [Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v3.8.0...v3.8.1) Bug fixes: - Fixed two errors relative to includer indentation for both directives. ### [`v3.8.0`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v3.8.0) [Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v3.7.1...v3.8.0) New features: - Allow to configure globally some arguments passed to directives, see [Configuration π](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/tree/v3.8.0#configuration) ### [`v3.7.1`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v3.7.1) [Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v3.7.0...v3.7.1) Bug fixes: - HTML-escape file paths in comments generated by `include-markdown` directive to prevent broken content when including some edge cases. ### [`v3.7.0`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v3.7.0) [Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v3.6.1...v3.7.0) New features: - Added new argument `encoding` for both directives. ### [`v3.6.1`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v3.6.1) [Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v3.6.0...v3.6.1) Bug fixes: - Wrap `start` and `end` delimiters contents by single quotes in comments to show them better. ### [`v3.6.0`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v3.6.0) [Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v3.5.2...v3.6.0) New features: - Allow to configure globally custom tags strings to open and close directives ([#112](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/issues/112)). ### [`v3.5.2`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v3.5.2) [Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v3.5.1...v3.5.2) Bug fixes: - Fixed incompatibility between `trailing-newlines` and `comments` arguments of `include-markdown` directive. ### [`v3.5.1`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v3.5.1) [Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v3.5.0...v3.5.1) Bug fixes: - Fixed nested inclusions showing incorrect warning messages. - Fixed error skipping relative URLs rewriting in indented codeblocks using Windows newlines. Enhancements: - Allow to pass string arguments wrapped by single quotes `'` escaping them with `\'`. - Show errors if `filename`, `end`, `start` or `exclude` arguments are empty. - Show error rather than raising an exception if a file to be included is not found. - Show error rather than raising an exception if a parsed boolean value is not valid. - Improved warning messages adding affected line number and directive. ### [`v3.5.0`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v3.5.0) [Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v3.4.1...v3.5.0) New features: - New option [`trailing-newlines`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/tree/1859d0008da744666343a0da0c1bcf8e408858f8#include-markdown_trailing-newlines) for both directives to strip trailing newlines from content to include. - Both directives accept now recursive `**` wildcard globbing to match against subdirectories including multiple files. Enhancements: - String arguments `filename`, `start`, `end` and `exclude` now accept double quotes `"` in values escaping them with `\"`. ### [`v3.4.1`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v3.4.1) [Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v3.4.0...v3.4.1) Bug fixes: - Fixed offset application not skipped in codeblocks at nested Markdown blocks. - Fixed incorrect output skipping relative URL rewritings in indented codeblocks. Enhancements: - Optimize migrating from `pathlib` to `os.path`. - Some tiny performance optimizations processing text. ### [`v3.4.0`](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/releases/tag/v3.4.0) [Compare Source](https://togithub.com/mondeja/mkdocs-include-markdown-plugin/compare/v3.3.0...v3.4.0) Enhancements: - Warn if `end` or `start` arguments are not detected inside content to include.Configuration
π Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
π¦ Automerge: Disabled by config. Please merge this manually once you are satisfied.
β» Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
π Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate. View repository job log here.