Added support for Mermaid diagramming library and gave one simple exa…

…mple of using it
python-cmd2 · Dec 23, 2024 · 8020699 · 8020699
1 parent 94e2495
commit 8020699
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 21 deletions.
diff --git a/docs/features/scripting.md b/docs/features/scripting.md
@@ -79,26 +79,23 @@ If the cmd2 application follows the [unix_design_philosophy](https://en.wikipedi
 
 The following diagram illustrates the different boundaries to keep in mind.
 
-    +---------------------------------------------+
-    |                                             |
-    | Py scripts                                  |
-    |                                             |
-    | +-----------------------------------------+ |
-    | |  CMD2 Application                       | |
-    | |                                         | |
-    | | +-------------------------------------+ | |
-    | | |   Class Library                     | | |
-    | | | +------+ +------+ +------+ +------+ | | |
-    | | | |      | |      | |      | |      | | | |
-    | | | |  C   | |  C   | |  C   | |  C   | | | |
-    | | | |      | |      | |      | |      | | | |
-    | | | +------+ +------+ +------+ +------+ | | |
-    | | |                                     | | |
-    | | +-------------------------------------+ | |
-    | |                                         | |
-    | +-----------------------------------------+ |
-    |                                             |
-    +---------------------------------------------+
+```mermaid
+flowchart LR
+    subgraph Py scripts
+        direction TB
+        subgraph cmd2 Application
+            direction TB
+            subgraph Class Library
+                direction TB
+                class1
+                class2
+                class3
+                class4
+            end
+        end
+    end
+
+```
 
 !!! note
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -121,6 +121,10 @@ markdown_extensions:
   - pymdownx.keys
   - pymdownx.smartsymbols
   - pymdownx.superfences:
+      custom_fences:
+          - name: mermaid
+            class: mermaid
+            format: !!python/name:pymdownx.superfences.fence_code_format
   - pymdownx.tabbed:
       alternate_style: true
 
@@ -210,7 +214,7 @@ nav:
   - Meta:
       - doc_conventions.md
 
-# Include extra CSS to make some style adjustments
+# Include extra CSS to make some style adjustments for ReadTheDocs
 extra_css:
   - stylesheets/readthedocs.css