15308555518/ docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-12-26 01:33:02 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: document theme-mermaid in API sidebar (#8417)

This commit is contained in:
Mikey O'Toole 2022-12-07 04:45:57 +00:00 committed by GitHub
parent eecfdebf08
commit b7cbc967ce
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
website/docs/api/themes/theme-mermaid.md Normal file
View File

@ -0,0 +1,25 @@
---
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"
module.exports = {
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,
},
};
```