build: restrict supported mermaid versions

sjwall · Jan 8, 2022 · 0746bc3 · prince-chrismc · Jun 1, 2022 · 0746bc3
1 parent ce8a106
commit 0746bc3
Show file tree

Hide file tree

Showing 4 changed files with 1,839 additions and 499 deletions.
diff --git a/doc/docs/mermaid-versions.md b/doc/docs/mermaid-versions.md
@@ -0,0 +1,11 @@
+---
+sidebar_position: 4
+---
+
+# Supported Mermaid versions
+
+This library supports Mermaid versions `>= 8.11.0 < 8.12.0`
+
+The version needs to be at least `8.11.0` due to this issue: https://github.com/sjwall/mdx-mermaid/issues/20
+
+The version needs to be less than `8.12.0` due to the `d3` version upgrade to modules https://github.com/mermaid-js/mermaid/issues/2559
diff --git a/doc/docs/theme.mdx b/doc/docs/theme.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 2
+sidebar_position: 3
 ---
 
 # Theme

diff --git a/package.json b/package.json
@@ -31,7 +31,7 @@
     "jsx"
   ],
   "peerDependencies": {
-    "mermaid": "^8.0.0",
+    "mermaid": ">= 8.11.0 < 8.12.0",
     "react": "^16.8.4 || ^17.0.0",
     "unist-util-visit": "^2.0.0"
   },