chore: integrate mermaid.js into the build process and update initialization in extra.js #1919
Conversation
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
…ization in extra.js - Added mermaid.min.js to the build output in webpack.common.js. - Updated mermaid initialization in extra.js to use the new API. - Included mermaid.min.js script in foot.ejs, pretty.ejs, and slide.ejs for rendering diagrams. Signed-off-by: Yukai Huang <[email protected]>
Yukaii
force-pushed
the
bugfix/dev-2044-mermaid-bundling-issue
branch
from
c6e7d3b to
97b3ad8
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR integrates Mermaid.js into the build pipeline and updates the initialization and rendering logic in extra.js to use Mermaid’s new API.
- Add
mermaid.min.jsto Webpack’s output and remove legacy loader entries - Inject
mermaid.min.jsscript tags into EJS templates - Refactor
extra.jsto callmermaid.initializeandmermaid.runinstead of the old API
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| webpack.common.js | Add copy step for mermaid.min.js and drop old script-loader!mermaid entries |
| public/views/slide.ejs | Include Mermaid script tag in slide view |
| public/views/pretty.ejs | Include Mermaid script tag in pretty print view |
| public/views/codimd/foot.ejs | Include Mermaid script tag in CodiMD foot template |
| public/js/extra.js | Replace startOnLoad assignment with mermaid.initialize, switch mermaid.init to mermaid.run |
Comments suppressed due to low confidence (4)
public/js/extra.js:439
- [nitpick] The callback parameters
keyandvalueare ambiguous; consider renaming them toindexandelementfor clarity.
mermaids.each(async (key, value) => {
public/js/extra.js:257
- New API usage in
extra.jsshould be covered by unit or integration tests (e.g., mockingmermaid.initializeand verifyingmermaid.runcalls) to ensure diagrams render as expected.
window.mermaid.initialize({
public/views/pretty.ejs:108
- Indentation is inconsistent with the surrounding
<script>tags; consider adding the same leading whitespace to match the existing style.
<script src="<%- serverURL %>/build/mermaid/mermaid.min.js" defer></script>
public/views/codimd/foot.ejs:33
- This
<script>tag is not indented like the others in this block; adjust whitespace to maintain consistency.
<script src="<%- serverURL %>/build/mermaid/mermaid.min.js" defer></script>
- Refactored the mermaid rendering logic to utilize the latest API for generating diagrams. - Improved error handling by displaying the error message directly instead of using a string property. - Ensured that the diagram's HTML is updated correctly after rendering. Signed-off-by: Yukai Huang <[email protected]>
jackycute
approved these changes
Jun 5, 2025
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.
Signed-off-by: Yukai Huang [email protected]