Skip to content

docs: document theme-mermaid in API sidebar #8417

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
Josh-Cena merged 4 commits into from
Dec 7, 2022
Merged

docs: document theme-mermaid in API sidebar #8417

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
efd2410
docs(content-docs): document theme-mermaid in the api/themes section.
homotechsual Dec 7, 2022
31a5cdd
Actually commit the content.
homotechsual Dec 7, 2022
8564659
Update website/docs/api/themes/theme-mermaid.md
homotechsual Dec 7, 2022
f60ff23
Update website/docs/api/themes/theme-mermaid.md
homotechsual Dec 7, 2022
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
23 changes: 23 additions & 0 deletions website/docs/api/themes/theme-mermaid.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
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'],
markdown: {
mermaid: true,
},
};
```