feat: add mermaid diagram rendering with interactive viewer#349
Open
Benonii wants to merge 1 commit into
Open
Conversation
|
@Benonii is attempting to deploy a commit to the better-auth Team on Vercel. A member of the Team first needs to authorize it. |
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.
Problem
Mermaid diagrams in docs were not being recognized and rendered correctly with the current markdown-renderer component.
Fix
Install mermaid package, create a
mermaid-diagram.tsx(a use client component) and use it to render mermaid diagrams when they are encountered.changes
apps/web/package.json: added"mermaid": "^11.14.0"apps/web/src/components/shared/highlighted-code-block.tsx: Changed one function to first check if lang is "mermaid" and return<MermaidDiagram>if that's the case. If not return old function.apps/web/src/components/shared/markdown-renderer.tsx: Replace mermaid blocks with placeholder divs but save the code. After the HTML parser runs swap placeholder for real output. Also wraps the div containing HTML with<MermaidBlocks>apps/web/src/components/shared/markdown-renderer.tsx: new file. Handles displaying mermaid diagrams inline and with an interactive viewer and copy, expand, pan and zoom buttonsbun.lockBefore:
After: