fix: add mermaid.js library for diagram rendering #227
Conversation
This file contains 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
cunla
approved these changes
Mar 15, 2025
|
What URL is the diagram not rendered? Looking here: https://django-tasks-scheduler.readthedocs.io/en/latest/ - I see the diagram fine. |
|
@cunla It may be related to my browser location, because it does not load for me, and diagrams do not appear I got 520 from: https://unpkg.com/mermaid@11/dist/mermaid.min.js If you specify a CDN in your configuration, the system will use that CDN instead of unpkg., choosing a CDN will avoid these problems. 
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR fixes the Mermaid diagram rendering issue in the documentation by explicitly adding the Mermaid JavaScript library. Even though Material for MkDocs has built-in Mermaid support in newer versions, explicitly adding the library resolves rendering problems with sequence diagrams and other Mermaid-based visualizations.
Changes:
Before:
After:
