Skip to content

Commit

Permalink
Enable mermaid diagrams in docusaurus (#6957)
Browse files Browse the repository at this point in the history
# Pull Request

## 📖 Description

Pursuant to [PR comment](#6947 (review)), this enables mermaid diagrams to be displayed with the new docusaurus v3 update.

## ✅ Checklist

### General

<!--- Review the list and put an x in the boxes that apply. -->

- [ ] I have included a change request file using `$ yarn change`
- [ ] I have added tests for my changes.
- [x] I have tested my changes.
- [ ] I have updated the project documentation to reflect my changes.
- [x] I have read the [CONTRIBUTING](https://github.com/microsoft/fast/blob/master/CONTRIBUTING.md) documentation and followed the [standards](/docs/community/code-of-conduct/#our-standards) for this project.
  • Loading branch information
janechu authored May 22, 2024
1 parent 22367a8 commit 5f1e6fa
Show file tree
Hide file tree
Showing 3 changed files with 459 additions and 10 deletions.
8 changes: 7 additions & 1 deletion sites/website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,13 @@ module.exports = {
organizationName: "microsoft",
projectName: "fast",
onBrokenLinks: "log",
themes: [require.resolve("@docusaurus/theme-live-codeblock")],
markdown: {
mermaid: true,
},
themes: [
require.resolve("@docusaurus/theme-live-codeblock"),
"@docusaurus/theme-mermaid",
],
staticDirectories: ["static"],
themeConfig: {
colorMode: {
Expand Down
1 change: 1 addition & 0 deletions sites/website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
"@docusaurus/module-type-aliases": "^3.2.1",
"@docusaurus/preset-classic": "^3.2.1",
"@docusaurus/theme-live-codeblock": "^3.2.1",
"@docusaurus/theme-mermaid": "^3.2.1",
"@docusaurus/types": "^3.2.1",
"@mdx-js/react": "^3.0.1",
"@microsoft/api-documenter": "^7.24.2",
Expand Down
Loading

0 comments on commit 5f1e6fa

Please sign in to comment.