🟠Minor breaking changes: This release will change some of the git revision dates:
We now ignore changes to files that only contain whitespaces or blanklines, as these are not 'real' revisions to the content. This maps to the git log --ignore_all_space --ignore_blank_lines.
We now ignore rename commits for determining the last revision date, as these are not 'real' revisions to the content. This maps to the git log diff-filter=r command (see git log docs)
We will now follow changes to a file across file renames (including moving files around). This maps to git log --follow. While giving more accurate revision and creation dates, there is an edge case: if you commit empty files, the revision date might wrong. For details see this blogpost. You can opt-out of this behavior by using the new option enable_git_follow (which defaults to True). If you still hit inaccurate revision dates for specific files, consider manually defining them.
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 = []() { .... };
Commits
76f01cc Indented code blocks surrounded by newlines (#234)
7daca94 Set comments=false as default for include-markdown directive (#233)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency
- `@dependabot ignore major version` will close this group update PR and stop Dependabot creating any more for the specific dependency's major version (unless you unignore this specific dependency's major version or upgrade to it yourself)
- `@dependabot ignore minor version` will close this group update PR and stop Dependabot creating any more for the specific dependency's minor version (unless you unignore this specific dependency's minor version or upgrade to it yourself)
- `@dependabot ignore ` will close this group update PR and stop Dependabot creating any more for the specific dependency (unless you unignore this specific dependency or upgrade to it yourself)
- `@dependabot unignore ` will remove all of the ignore conditions of the specified dependency
- `@dependabot unignore ` will remove the ignore condition of the specified dependency and ignore conditions
Bumps the dependencies group with 3 updates in the /docs directory: mkdocs-git-revision-date-localized-plugin, mkdocs-include-markdown-plugin and mkdocs-macros-plugin.
Updates
mkdocs-git-revision-date-localized-plugin
from 1.2.9 to 1.3.0Release notes
Sourced from mkdocs-git-revision-date-localized-plugin's releases.
Commits
2e7646e
update to v1.31e69247
support python 3.139e064cd
Merge pull request #148 from skywarth/master36b2159
chore: rename option, add documentationf848ea1
feat: reverted previous changes about exclude option, new option for follow i...466e577
feat: option for excluding renames and move operations for last update dateUpdates
mkdocs-include-markdown-plugin
from 6.2.2 to 7.0.0Release notes
Sourced from mkdocs-include-markdown-plugin's releases.
Commits
76f01cc
Indented code blocks surrounded by newlines (#234)7daca94
Setcomments=false
as default forinclude-markdown
directive (#233)ef88880
Python v3.8 EOL (#232)2fee006
Update tooling (#230)Updates
mkdocs-macros-plugin
from 1.3.6 to 1.3.7Changelog
Sourced from mkdocs-macros-plugin's changelog.
Commits
b906a36
Bump version number5641806
Fixed incompatibility with d2 module (#249)Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase
.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show