feat: add PreviewableCode component with Mermaid and PlantUML support #1131
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.
Overview
This PR introduces a new
PreviewableCode
component that enhances code block rendering in MDX by providing an interactive tabbed interface for previewable content. It supports rendering of Mermaid diagrams and PlantUML diagrams directly in the browser.Key Features
Technical Details
PreviewableCode.tsx
: Main component for handling previewable code blocksMermaid.tsx
: Client-side Mermaid diagram rendererPlantUML.tsx
: Server-side PlantUML diagram rendererMDXComponents.tsx
to use the new PreviewableCode componentmermaid
: For client-side diagram renderingplantuml-encoder
: For PlantUML diagram encoding@types/plantuml-encoder
: TypeScript type definitionsUsage Examples
The component can be used in MDX files with the following syntax:
Testing
previewable_code.mdx
with examples and documentationNotes