Added Mermaid diagram support.

AlexSkrypnyk · Mar 26, 2024 · ccd0686 · ccd0686 · github-actions · Mar 26, 2024
1 parent 05dde69
commit ccd0686
Show file tree

Hide file tree

Showing 4 changed files with 4,543 additions and 2,601 deletions.
diff --git a/docs/content/documentation.mdx b/docs/content/documentation.mdx
@@ -17,6 +17,22 @@ own project.
 The [configuration file](https://github.com/AlexSkrypnyk/scaffold/blob/main/docs/docusaurus.config.js)
 allows to adjust the documentation to your needs.
 
+## Diagrams
+
+The configuration file includes [Mermaid](https://mermaid.js.org/) support for
+diagrams.
+
+See the [Mermaid syntax documentation](https://mermaid.js.org/intro/syntax-reference.html)
+for more information on the Mermaid syntax.
+
+```mermaid
+graph TD;
+    A-->B;
+    A-->C;
+    B-->D;
+    C-->D;
+```
+
 ## Spell checking
 
 Spell checking uses [CSpell](https://cspell.org/) and a [custom configuration

diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -61,9 +61,13 @@ const config = {
     ],
   ],
 
+  markdown: {
+    mermaid: true,
+  },
+
   themes: [
     [
-      "@easyops-cn/docusaurus-search-local",
+      '@easyops-cn/docusaurus-search-local',
       /** @type {import("@easyops-cn/docusaurus-search-local").PluginOptions} */
       ({
         // @see https://github.com/easyops-cn/docusaurus-search-local#theme-options
@@ -75,6 +79,7 @@ const config = {
         explicitSearchResultPath: true,
       }),
     ],
+    '@docusaurus/theme-mermaid',
   ],
 
   themeConfig: