Skip to content

Commit

Permalink
Use mermaid for class diagrams
Browse files Browse the repository at this point in the history
  • Loading branch information
SerTetora authored Dec 23, 2023
1 parent 2b2610b commit cad5442
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 30 deletions.
11 changes: 3 additions & 8 deletions docs/cards.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,13 +151,9 @@ markdown_extensions:

### Schema

```plantuml
@startuml "Cards"
!theme plain
left to right direction
hide empty members
```mermaid
classDiagram
direction LR
class CardItem {
title: str
Expand All @@ -174,7 +170,6 @@ class Cards {
Cards --> CardItem
@enduml
```

```python
Expand Down
12 changes: 3 additions & 9 deletions docs/gantt.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ markdown_extensions:

### Examples


=== "JSON"

```json
Expand Down Expand Up @@ -169,13 +168,9 @@ markdown_extensions:
The input for a Gantt diagram is a list of activities having a shape described
by the following scheme:

```plantuml
@startuml "Timeline"
!theme plain
left to right direction
hide empty members
```mermaid
classDiagram
direction LR
class Event {
title: str
Expand All @@ -197,7 +192,6 @@ class Activity {
Activity --> Event
Activity --> Activity
@enduml
```

```python
Expand Down
12 changes: 3 additions & 9 deletions docs/timeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,13 +104,9 @@ markdown_extensions:

### Schema

```plantuml
@startuml "Timeline"
!theme plain
left to right direction
hide empty members
```mermaid
classDiagram
direction LR
class TimelineItem {
title: str
Expand All @@ -124,10 +120,8 @@ class Timeline {
items: Array of TimelineItem
}
Timeline --> TimelineItem
@enduml
```

```python
Expand Down
8 changes: 5 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,13 @@ markdown_extensions:
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tabbed:
alternate_style: true
- footnotes
- plantuml_markdown:
server: http://www.plantuml.com/plantuml
1 change: 0 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ neoteroi-mkdocs
oauthlib==3.2.0
packaging==21.3
pathspec==0.9.0
plantuml-markdown==3.6.3
platformdirs==2.5.2
pycparser==2.21
Pygments==2.12.0
Expand Down

0 comments on commit cad5442

Please sign in to comment.