@inkset/diagram
v0.1.6
Published
Mermaid diagram plugin for Inkset.
Downloads
754
Maintainers
Readme
@inkset/diagram
Mermaid diagram plugin for Inkset.
Install
npm install @inkset/diagram mermaidUsage
import { Inkset } from "@inkset/react";
import { createDiagramPlugin } from "@inkset/diagram";
const plugins = [createDiagramPlugin({ theme: "neutral" })];
export const Example = ({ content }: { content: string }) => {
return <Inkset content={content} plugins={plugins} />;
};@inkset/diagram handles Mermaid fenced code blocks and renders them as measured diagram blocks inside the Inkset layout pipeline.
It uses the core plugin system's canHandle gate to claim only code blocks whose language matches (default "mermaid"), so @inkset/code still owns every other language when both are registered.
Options
theme— Mermaid theme name."default" | "dark" | "neutral" | "forest" | "base". Default"dark".language— language string this plugin claims. Default"mermaid".showHeader— show the header bar (lang label + copy button). Defaulttrue.showCopy— show the copy button in the header. Defaulttrue.
mermaid is an optional peer dependency; install it alongside @inkset/diagram. Without it, blocks fall back to their raw source.
