# `@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

```sh
npm i @theguild/remark-mermaid
```

## Usage

Follow code will be converted to a mermaid diagram.

````mdx
// 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;
```
````
