Skip to content

docs: Add docs for Mermaid Component #9816

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
slorber merged 6 commits into from
Feb 2, 2024
Merged

docs: Add docs for Mermaid Component #9816

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e1d12e1
add docs
Its-Just-Nans Feb 1, 2024
6616b22
fix: missplace
Its-Just-Nans Feb 1, 2024
8027e94
Update markdown-features-diagrams.mdx
Its-Just-Nans Feb 2, 2024
4c4c47d
yarn format
Its-Just-Nans Feb 2, 2024
a2c04a3
fix: correct language
Its-Just-Nans Feb 2, 2024
3a190a2
fix: typo
Its-Just-Nans Feb 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions website/docs/guides/markdown-features/markdown-features-diagrams.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,3 +83,19 @@ export default {
```

See the [Mermaid config documentation](https://mermaid-js.github.io/mermaid/#/./Setup?id=configuration) and the [Mermaid config types](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts) for the available config options.

## Dynamic Mermaid Component {#component}

To generate dynamic diagrams, you can use the `Mermaid` component:

```mdx title="Example of dynamic Mermaid component"
import Mermaid from '@theme/Mermaid';

<Mermaid
value={`graph TD;
A-->B;
A-->C;
B-->D;
C-->D;`}
/>
```
16 changes: 16 additions & 0 deletions ...oned_docs/version-3.1.1/guides/markdown-features/markdown-features-diagrams.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,3 +83,19 @@ export default {
```

See the [Mermaid config documentation](https://mermaid-js.github.io/mermaid/#/./Setup?id=configuration) and the [Mermaid config types](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts) for the available config options.

Comment thread
Its-Just-Nans marked this conversation as resolved.
## Dynamic Mermaid Component {#component}

To generate dynamic diagrams, you can use the `Mermaid` component:

```mdx title="Example of dynamic Mermaid component"
import Mermaid from '@theme/Mermaid';

<Mermaid
value={`graph TD;
A-->B;
A-->C;
B-->D;
C-->D;`}
/>
```