Eliminate use of the include-markdown plugin for MkDocs#1544
Merged
tleonhardt merged 2 commits intomainfrom Dec 22, 2025
Merged
Eliminate use of the include-markdown plugin for MkDocs#1544tleonhardt merged 2 commits intomainfrom
tleonhardt merged 2 commits intomainfrom
Conversation
Replace it's use with simply refactoring some of the documentaiton and also using the pymdown.snippets extension which is more reliably supported by MkDocs. This is based in part on real-world problems encountered using the include-markdown problem with various other plugins and with migrating to Zensical.
Contributor
|
🤖 Hi @tleonhardt, I've received your request, and I'm working on it now! You can track my progress in the logs for more details. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1544 +/- ##
=======================================
Coverage 98.92% 98.92%
=======================================
Files 21 21
Lines 4942 4942
=======================================
Hits 4889 4889
Misses 53 53
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Contributor
|
🤖 I'm sorry @tleonhardt, but I was unable to process your request. Please see the logs for more details. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Eliminate use of the include-markdown plugin for
MkDocs.Replace it's use with simply refactoring some of the documentation and also using the
pymdown.snippetsextension which is more reliably supported byMkDocs.This is based in part on real-world problems encountered using the
include-markdownproblem with various other plugins and in part on experimental attempts to migrate to Zensical.