Skip to content

Commit 1eee0c8

Browse files
authored
Bump mkdocs-include-markdown-plugin from 6.2.2 to 7.0.0 (#331)
Bumps [mkdocs-include-markdown-plugin](https://github.com/mondeja/mkdocs-include-markdown-plugin) from 6.2.2 to 7.0.0. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/mondeja/mkdocs-include-markdown-plugin/releases">mkdocs-include-markdown-plugin's releases</a>.</em></p> <blockquote> <h2>v7.0.0</h2> <h2>Breaking changes</h2> <h3>No longer installable on Python v3.8</h3> <p>Minimum Python version for installation is v3.9. Python v3.8 reached his end of life at 2024-10-07.</p> <h3>Comments are turned off by default</h3> <p>Before this release, the default value for <code>comments</code> argument of <code>include-markdown</code> directive was <code>true</code>. Now has been switched to <code>false</code>. This prevents some inconvenients, for example, trying to include one-line texts on table cells and list items.</p> <p>If you want the previous behaviour, configure <code>comments</code> as <code>true</code> in the global configuration:</p> <pre lang="yaml"><code>plugins: - include-markdown: comments: true </code></pre> <h3>Indented code blocks must be surrounded by newlines</h3> <p>Now mkdocs-include-markdown-plugin will only detect indented code blocks if are surrounded by newlines, conforming to <a href="https://spec.commonmark.org/0.28/#indented-code-blocks">CommonMark specification</a>.</p> <p>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:</p> <pre lang="markdown"><code>Foo const auto lambda = []() { .... }; </code></pre> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/mondeja/mkdocs-include-markdown-plugin/commit/76f01cc8efaed5d8dc6f304ecb42be92cd9ca96f"><code>76f01cc</code></a> Indented code blocks surrounded by newlines (<a href="https://redirect.github.com/mondeja/mkdocs-include-markdown-plugin/issues/234">#234</a>)</li> <li><a href="https://github.com/mondeja/mkdocs-include-markdown-plugin/commit/7daca941478b187565b0c2724acd15f70c4112b3"><code>7daca94</code></a> Set <code>comments=false</code> as default for <code>include-markdown</code> directive (<a href="https://redirect.github.com/mondeja/mkdocs-include-markdown-plugin/issues/233">#233</a>)</li> <li><a href="https://github.com/mondeja/mkdocs-include-markdown-plugin/commit/ef8888012115e5b982b142b112a2d92b1b9894ee"><code>ef88880</code></a> Python v3.8 EOL (<a href="https://redirect.github.com/mondeja/mkdocs-include-markdown-plugin/issues/232">#232</a>)</li> <li><a href="https://github.com/mondeja/mkdocs-include-markdown-plugin/commit/2fee006ee3b068588894a14099d064a855c447b9"><code>2fee006</code></a> Update tooling (<a href="https://redirect.github.com/mondeja/mkdocs-include-markdown-plugin/issues/230">#230</a>)</li> <li>See full diff in <a href="https://github.com/mondeja/mkdocs-include-markdown-plugin/compare/v6.2.2...v7.0.0">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=mkdocs-include-markdown-plugin&package-manager=pip&previous-version=6.2.2&new-version=7.0.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) 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-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> 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 <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details>
2 parents f92e1ef + 81a713f commit 1eee0c8

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ dev-mkdocs = [
5252
"markdown-svgbob == 202406.1023",
5353
"mike == 2.1.3",
5454
"mkdocs-gen-files == 0.5.0",
55-
"mkdocs-include-markdown-plugin == 6.2.2",
55+
"mkdocs-include-markdown-plugin == 7.0.0",
5656
"mkdocs-literate-nav == 0.6.1",
5757
"mkdocs-macros-plugin == 1.2.0",
5858
"mkdocs-material == 9.5.39",

0 commit comments

Comments
 (0)