@theguild/remark-mermaid
TypeScript icon, indicating that this package has built-in type declarations

0.0.6 • Public • Published

@theguild/remark-mermaid

Created by Dimitri POSTOLOV https://twitter.com/B2o5T.

Maintained by The Guild https://twitter.com/TheGuildDev.

Remark plugin for replacing ```mermaid code blocks with react <Mermaid /> component.

  • Support MDX2

  • Support both dark and light themes. Listening for the dark class on the <html /> element and updating the mermaid's theme accordingly

Install

npm i @theguild/remark-mermaid

Usage

Follow code will be converted to a mermaid diagram.

// my-page.mdx

```mermaid
graph TD;
subgraph AA [Consumers]
A[Mobile app];
B[Web app];
C[Node.js client];
end
subgraph BB [Services]
E[REST API];
F[GraphQL API];
G[SOAP API];
end
Z[GraphQL API];
A --> Z;
B --> Z;
C --> Z;
Z --> E;
Z --> F;
Z --> G;
```

Readme

Keywords

none

Package Sidebar

Install

npm i @theguild/remark-mermaid

Weekly Downloads

66,076

Version

0.0.6

License

MIT

Unpacked Size

5.5 kB

Total Files

6

Last publish

Collaborators

  • dotansimha
  • kamilkisiela
  • urigo