mirror of
https://github.com/facebook/docusaurus.git
synced 2025-06-19 19:22:28 +02:00
45f1a669b5
Co-authored-by: Joshua Chen <sidachen2003@gmail.com> Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
25 lines
679 B
Text
25 lines
679 B
Text
---
|
|
sidebar_position: 5
|
|
slug: /api/themes/@docusaurus/theme-mermaid
|
|
---
|
|
|
|
# 📦 theme-mermaid
|
|
|
|
This theme provides a `@theme/Mermaid` component that is powered by [mermaid](https://mermaid-js.github.io/). You can read more on [diagrams](../../guides/markdown-features/markdown-features-diagrams.mdx) documentation.
|
|
|
|
```bash npm2yarn
|
|
npm install --save @docusaurus/theme-mermaid
|
|
```
|
|
|
|
## Configuration {#configuration}
|
|
|
|
```js title="docusaurus.config.js"
|
|
export default {
|
|
themes: ['@docusaurus/theme-mermaid'],
|
|
// In order for Mermaid code blocks in Markdown to work,
|
|
// you also need to enable the Remark plugin with this option
|
|
markdown: {
|
|
mermaid: true,
|
|
},
|
|
};
|
|
```
|