feat: handle mermaid in documentation#61
Merged
this-is-tobi merged 1 commit intomainfrom Mar 16, 2026
Merged
Conversation
Contributor
|
🤖 Hey ! The security scan report for the current pull request is available here. |
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
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.
Description
Add support for Mermaid diagrams in built documentation by integrating
vitepress-plugin-mermaid.The
withMermaid()wrapper was previously applied during config generation, causing its Vite plugin and markdown-it extensions (which are functions) to be silently dropped byJSON.stringify. The fix moves thewithMermaid()call into the generated.vitepress/config.tsso it is evaluated at VitePress runtime, making Mermaid diagrams fully functional in built docs.Additionally, pre-existing type errors in the test suite were fixed:
readdirSyncmocks were casting toDirent<Buffer<ArrayBufferLike>>[], which is incompatible with newer@types/nodewhere the type isDirent<NonSharedBuffer>[]. All casts were replaced withas any.Type of change
How Has This Been Tested?
The full test suite (214 tests across 14 files) passes locally. TypeScript compilation (
tsc) and Vite build both succeed without errors or warnings.Test Configuration:
Checklist: