backstage-plugin-techdocs-addon-mermaid

backstage-plugin-techdocs-addon-mermaid

The backstage-plugin-techdocs-addon-mermaid allows rendering of Mermaid diagrams within Backstage TechDocs

This plugin is a Backstage TechDocs Addon, which requires Backstage v1.2+

Getting started

Follow the official documentation for TechDocs Addons to use this addon.

import { Mermaid } from 'backstage-plugin-techdocs-addon-mermaid';

// ...
{techDocsPage}
<TechDocsAddons>
  {/*...*/}
  <Mermaid config={{ theme: 'forest', themeVariables: { lineColor: '#000000' } }} />
</TechDocsAddons>

Use Mermaid in your TechDocs

# Mermaid section

Here is a mermaid graph!

```mermaid
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;
```