Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update dependency mkdocs-include-markdown-plugin to v7 #281

Merged
merged 1 commit into from
Dec 16, 2024

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Nov 18, 2024

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
mkdocs-include-markdown-plugin (changelog) ==6.0.5 -> ==7.1.2 age adoption passing confidence

Release Notes

mondeja/mkdocs-include-markdown-plugin (mkdocs-include-markdown-plugin)

v7.1.2

Compare Source

Enhancements

  • Add cache_dir global setting to configure the path to the cache directory. When setted avoids the requirement to install platformdirs to use HTTP caching.

v7.1.1

Compare Source

New features

Enhancements

  • Some performance optimizations (#​240)

v7.0.1

Compare Source

Enhancements

  • Performance optimization up to 25% faster.

v7.0.0

Compare Source

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

v6.2.2

Compare Source

Enhancements

  • Add official support for Python v3.13.
  • Relax wcmatch dependency.

v6.2.1

Compare Source

Bug fixes
  • Improve performance of inclusion regex processing. Prevents to take a lot of time parsing long lines looking for inclusions.

v6.2.0

Compare Source

New features
  • Add recursive argument to include-markdown directive.
Enhancements
  • Apply substitutions from all directives at once. Improves performance in all includes and prevents big performance degradations including large contents in the same files of other includes.
  • Warn when passing invalid arguments to directives. It could catches bad syntax, like trying to turning off comments in include directives (include does not provides a comments argument).

v6.1.1

Compare Source

Enhancements

  • Change substitions order of directives. Prevents performance degradations when including long files with include directive in the same file with other include-markdown directive.

v6.1.0

Compare Source

New features

  • Add a new recursive argument to the include directive that allows to stop recursively processing includes in included files.

v6.0.7

Compare Source

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

Compare Source

Bug fixes

  • Fixed errors when using Mkdocs>=1.6.0 generated files (#​205). Now if you try to include using a relative path from a generated file, an error will be raised.

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 is behind base branch, 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 was generated by Mend Renovate. View the repository job log.

@renovate renovate bot added chore Maintenance dependencies Pull requests that update a dependency file. labels Nov 18, 2024
@renovate renovate bot force-pushed the renovate/mkdocs-include-markdown-plugin-7.x branch 2 times, most recently from b49dce5 to d24174e Compare November 21, 2024 07:43
@renovate renovate bot force-pushed the renovate/mkdocs-include-markdown-plugin-7.x branch from d24174e to d010103 Compare November 29, 2024 17:12
@renovate renovate bot force-pushed the renovate/mkdocs-include-markdown-plugin-7.x branch from d010103 to 690c636 Compare December 16, 2024 22:50
@renovate renovate bot force-pushed the renovate/mkdocs-include-markdown-plugin-7.x branch from 690c636 to 3ff62d4 Compare December 16, 2024 22:53
@github-actions github-actions bot merged commit 636cb9f into develop Dec 16, 2024
8 checks passed
@github-actions github-actions bot deleted the renovate/mkdocs-include-markdown-plugin-7.x branch December 16, 2024 22:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge chore Maintenance dependencies Pull requests that update a dependency file.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant