Skip to content

Commit 4b0bfec

Browse files
authored
update mermaid diagram configuration (#1184)
Update the Docusaurus configuration to re-enable Mermaid diagrams, based on the current recommendation from the Docusaurus documentation. Use the 'default' theme in both light and dark mode, as this appears to match the v0.24 and previous docs site.
1 parent 483ad71 commit 4b0bfec

File tree

3 files changed

+53
-1
lines changed

3 files changed

+53
-1
lines changed

docusaurus.config.js

+8-1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,11 @@ const config = {
1919
projectName: 'documentation',
2020
trailingSlash: false,
2121

22+
markdown: {
23+
mermaid: true,
24+
},
25+
themes: ['@docusaurus/theme-mermaid'],
26+
2227
customFields: {
2328
xgridKey: process.env.XGRID_KEY,
2429
},
@@ -32,7 +37,6 @@ const config = {
3237
routeBasePath: '/',
3338
sidebarPath: require.resolve('./sidebars.js'),
3439
editUrl: 'https://github.com/pomerium/documentation/tree/main',
35-
remarkPlugins: [require('mdx-mermaid')],
3640
},
3741
theme: {
3842
customCss: require.resolve('./src/css/custom.css'),
@@ -177,6 +181,9 @@ const config = {
177181
'shell-session',
178182
],
179183
},
184+
mermaid: {
185+
theme: {light: 'default', dark: 'default'},
186+
},
180187
},
181188
stylesheets: [
182189
'https://fonts.googleapis.com/icon?family=Material+Icons',

package.json

+1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
"@docusaurus/core": "^3.0.1",
2121
"@docusaurus/preset-classic": "^3.0.1",
2222
"@docusaurus/theme-common": "^3.0.1",
23+
"@docusaurus/theme-mermaid": "3.0.1",
2324
"@docusaurus/types": "^3.0.1",
2425
"@emotion/react": "^11.11.3",
2526
"@emotion/styled": "^11.11.0",

yarn.lock

+44
Original file line numberDiff line numberDiff line change
@@ -2414,6 +2414,19 @@
24142414
tslib "^2.6.0"
24152415
utility-types "^3.10.0"
24162416

2417+
"@docusaurus/[email protected]":
2418+
version "3.0.1"
2419+
resolved "https://registry.yarnpkg.com/@docusaurus/theme-mermaid/-/theme-mermaid-3.0.1.tgz#a8e3db9f8ccb680f0a4359e2b0f6427f52223c15"
2420+
integrity sha512-jquSDnZfazABnC5i+02GzRIvufXKruKgvbYkQjKbI7/LWo0XvBs0uKAcCDGgHhth0t/ON5+Sn27joRfpeSk3Lw==
2421+
dependencies:
2422+
"@docusaurus/core" "3.0.1"
2423+
"@docusaurus/module-type-aliases" "3.0.1"
2424+
"@docusaurus/theme-common" "3.0.1"
2425+
"@docusaurus/types" "3.0.1"
2426+
"@docusaurus/utils-validation" "3.0.1"
2427+
mermaid "^10.4.0"
2428+
tslib "^2.6.0"
2429+
24172430
"@docusaurus/[email protected]":
24182431
version "3.0.1"
24192432
resolved "https://registry.yarnpkg.com/@docusaurus/theme-search-algolia/-/theme-search-algolia-3.0.1.tgz#d8fb6bddca8d8355e4706c4c7d30d3b800217cf4"
@@ -5420,6 +5433,11 @@ elkjs@^0.8.2:
54205433
resolved "https://registry.yarnpkg.com/elkjs/-/elkjs-0.8.2.tgz#c37763c5a3e24e042e318455e0147c912a7c248e"
54215434
integrity sha512-L6uRgvZTH+4OF5NE/MBbzQx/WYpru1xCBE9respNj6qznEewGUIfhzmm7horWWxbNO2M0WckQypGctR8lH79xQ==
54225435

5436+
elkjs@^0.9.0:
5437+
version "0.9.1"
5438+
resolved "https://registry.yarnpkg.com/elkjs/-/elkjs-0.9.1.tgz#fd1524b3f0bed72dc65ba107ae91bcf04b5582bd"
5439+
integrity sha512-JWKDyqAdltuUcyxaECtYG6H4sqysXSLeoXuGUBfRNESMTkj+w+qdb0jya8Z/WI0jVd03WQtCGhS6FOFtlhD5FQ==
5440+
54235441
emoji-regex@^8.0.0:
54245442
version "8.0.0"
54255443
resolved "https://registry.yarnpkg.com/emoji-regex/-/emoji-regex-8.0.0.tgz#e818fd69ce5ccfcb404594f842963bf53164cc37"
@@ -7542,6 +7560,32 @@ merge2@^1.3.0, merge2@^1.4.1:
75427560
resolved "https://registry.yarnpkg.com/merge2/-/merge2-1.4.1.tgz#4368892f885e907455a6fd7dc55c0c9d404990ae"
75437561
integrity sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==
75447562

7563+
mermaid@^10.4.0:
7564+
version "10.7.0"
7565+
resolved "https://registry.yarnpkg.com/mermaid/-/mermaid-10.7.0.tgz#4fd5bfd60c0c5e5c42016a82905f06c4684ec53b"
7566+
integrity sha512-PsvGupPCkN1vemAAjScyw4pw34p4/0dZkSrqvAB26hUvJulOWGIwt35FZWmT9wPIi4r0QLa5X0PB4YLIGn0/YQ==
7567+
dependencies:
7568+
"@braintree/sanitize-url" "^6.0.1"
7569+
"@types/d3-scale" "^4.0.3"
7570+
"@types/d3-scale-chromatic" "^3.0.0"
7571+
cytoscape "^3.23.0"
7572+
cytoscape-cose-bilkent "^4.1.0"
7573+
cytoscape-fcose "^2.1.0"
7574+
d3 "^7.4.0"
7575+
d3-sankey "^0.12.3"
7576+
dagre-d3-es "7.0.10"
7577+
dayjs "^1.11.7"
7578+
dompurify "^3.0.5"
7579+
elkjs "^0.9.0"
7580+
khroma "^2.0.0"
7581+
lodash-es "^4.17.21"
7582+
mdast-util-from-markdown "^1.3.0"
7583+
non-layered-tidy-tree-layout "^2.0.2"
7584+
stylis "^4.1.3"
7585+
ts-dedent "^2.2.0"
7586+
uuid "^9.0.0"
7587+
web-worker "^1.2.0"
7588+
75457589
mermaid@^10.6.1:
75467590
version "10.6.1"
75477591
resolved "https://registry.yarnpkg.com/mermaid/-/mermaid-10.6.1.tgz#701f4160484137a417770ce757ce1887a98c00fc"

0 commit comments

Comments
 (0)