rehype-declart

rehype-declart

rehype plugin that renders <pre><code class="language-declart"> blocks as inline SVG diagrams.

Install

npm install rehype-declart

Usage

import { unified } from 'unified';
import remarkParse from 'remark-parse';
import remarkRehype from 'remark-rehype';
import rehypeDeclart from 'rehype-declart';
import rehypeStringify from 'rehype-stringify';

const result = await unified()
  .use(remarkParse)
  .use(remarkRehype)
  .use(rehypeDeclart)
  .use(rehypeStringify)
  .process(`
\`\`\`declart
kind = "flow"
title = "Release Pipeline"

[[items]]
label = "Build"

[[items]]
label = "Test"
emphasis = "primary"

[[items]]
label = "Deploy"
\`\`\`
`);

console.log(String(result));
// → <figure class="declart"><svg ...>...</svg></figure>

Note: If you are using a remark-based pipeline, prefer remark-declart which operates at the Markdown AST level.

Options

Error handling

Invalid diagram declarations produce a <figure class="declart-error"> element with the error message, so the rest of the document continues to render.

Supported diagram kinds

flow (process · cycle · funnel) · tier (pyramid) · hierarchy (org_chart · fishbone) · matrix · hub_spoke · venn · timeline · comparison

License

MIT iyulab