JSPM

  • Created
  • Published
  • Downloads 17047
  • Score
    100M100P100Q225430F
  • License MIT

Package Exports

  • backstage-plugin-techdocs-addon-mermaid
  • backstage-plugin-techdocs-addon-mermaid/dist/index.esm.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (backstage-plugin-techdocs-addon-mermaid) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

backstage-plugin-techdocs-addon-mermaid

The backstage-plugin-techdocs-addon-mermaid allows to render Mermaid diagrams in your Backstage TechDocs

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

Getting started

Follow https://backstage.io/docs/features/techdocs/addons#installing-and-using-addons to use this addon.

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

      {techDocsPage}
      <TechDocsAddons>
        ...
        <Mermaid />
      </TechDocsAddons>

Use Mermaid in your TechDocs

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