Skip to content

Commit 8020699

Browse files
committed
Added support for Mermaid diagramming library and gave one simple example of using it
1 parent 94e2495 commit 8020699

File tree

2 files changed

+22
-21
lines changed

2 files changed

+22
-21
lines changed

docs/features/scripting.md

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -79,26 +79,23 @@ If the cmd2 application follows the [unix_design_philosophy](https://en.wikipedi
7979

8080
The following diagram illustrates the different boundaries to keep in mind.
8181

82-
+---------------------------------------------+
83-
| |
84-
| Py scripts |
85-
| |
86-
| +-----------------------------------------+ |
87-
| | CMD2 Application | |
88-
| | | |
89-
| | +-------------------------------------+ | |
90-
| | | Class Library | | |
91-
| | | +------+ +------+ +------+ +------+ | | |
92-
| | | | | | | | | | | | | |
93-
| | | | C | | C | | C | | C | | | |
94-
| | | | | | | | | | | | | |
95-
| | | +------+ +------+ +------+ +------+ | | |
96-
| | | | | |
97-
| | +-------------------------------------+ | |
98-
| | | |
99-
| +-----------------------------------------+ |
100-
| |
101-
+---------------------------------------------+
82+
```mermaid
83+
flowchart LR
84+
subgraph Py scripts
85+
direction TB
86+
subgraph cmd2 Application
87+
direction TB
88+
subgraph Class Library
89+
direction TB
90+
class1
91+
class2
92+
class3
93+
class4
94+
end
95+
end
96+
end
97+
98+
```
10299

103100
!!! note
104101

mkdocs.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,10 @@ markdown_extensions:
121121
- pymdownx.keys
122122
- pymdownx.smartsymbols
123123
- pymdownx.superfences:
124+
custom_fences:
125+
- name: mermaid
126+
class: mermaid
127+
format: !!python/name:pymdownx.superfences.fence_code_format
124128
- pymdownx.tabbed:
125129
alternate_style: true
126130

@@ -210,7 +214,7 @@ nav:
210214
- Meta:
211215
- doc_conventions.md
212216

213-
# Include extra CSS to make some style adjustments
217+
# Include extra CSS to make some style adjustments for ReadTheDocs
214218
extra_css:
215219
- stylesheets/readthedocs.css
216220

0 commit comments

Comments
 (0)