From e4fc8681623685bf20f8e6568a69b5b6c4d81d16 Mon Sep 17 00:00:00 2001 From: Henk Verlinde Date: Fri, 2 Jul 2021 13:51:57 +0200 Subject: [PATCH] content: remove temporary mermaid examples --- content/docs/prologue/quick-start.md | 159 --------------------------- 1 file changed, 159 deletions(-) diff --git a/content/docs/prologue/quick-start.md b/content/docs/prologue/quick-start.md index c95f282..9282d3e 100644 --- a/content/docs/prologue/quick-start.md +++ b/content/docs/prologue/quick-start.md @@ -11,167 +11,8 @@ menu: parent: "prologue" weight: 110 toc: true -mermaid: true --- -## Flowchart - -### Shortcode - -```md -{{}} -graph TD - A[Hard] -->|Text| B(Round) - B --> C{Decision} - C -->|One| D[Result 1] - C -->|Two| E[Result 2] -{{}} -``` - -{{< mermaid class="bg-light text-center">}} -graph TD - A[Hard] -->|Text| B(Round) - B --> C{Decision} - C -->|One| D[Result 1] - C -->|Two| E[Result 2] -{{< /mermaid >}} - -### Code fences - -````md -```mermaid -graph TD - A[Hard] -->|Text| B(Round) - B --> C{Decision} - C -->|One| D[Result 1] - C -->|Two| E[Result 2] -``` -```` - -```mermaid -graph TD - A[Hard] -->|Text| B(Round) - B --> C{Decision} - C -->|One| D[Result 1] - C -->|Two| E[Result 2] -``` - -## Sequence diagram - -{{< mermaid >}} -sequenceDiagram - Alice->>John: Hello John, how are you? - loop Healthcheck - John->>John: Fight against hypochondria - end - Note right of John: Rational thoughts! - John-->>Alice: Great! - John->>Bob: How about you? - Bob-->>John: Jolly good! -{{< /mermaid >}} - -## Class diagram - -{{< mermaid >}} -classDiagram - Class01 <|-- AveryLongClass : Cool - <> Class01 - Class09 --> C2 : Where am i? - Class09 --* C3 - Class09 --|> Class07 - Class07 : equals() - Class07 : Object[] elementData - Class01 : size() - Class01 : int chimp - Class01 : int gorilla - class Class10 { - <> - int id - size() - } -{{< /mermaid >}} - -## State diagram - -{{< mermaid >}} -stateDiagram-v2 - [*] --> Still - Still --> [*] - Still --> Moving - Moving --> Still - Moving --> Crash - Crash --> [*] -{{< /mermaid >}} - -## Entity Relationship Diagram - -{{< mermaid >}} -erDiagram - CUSTOMER ||--o{ ORDER : places - ORDER ||--|{ LINE-ITEM : contains - CUSTOMER }|..|{ DELIVERY-ADDRESS : uses -{{< /mermaid >}} - -## User Journey Diagram - -{{< mermaid >}} -journey - title My working day - section Go to work - Make tea: 5: Me - Go upstairs: 3: Me - Do work: 1: Me, Cat - section Go home - Go downstairs: 5: Me - Sit down: 3: Me -{{< /mermaid >}} - -## Gantt chart - -{{< mermaid >}} -gantt -dateFormat YYYY-MM-DD -title Adding GANTT diagram to mermaid -excludes weekdays 2014-01-10 - -section A section -Completed task :done, des1, 2014-01-06,2014-01-08 -Active task :active, des2, 2014-01-09, 3d -Future task : des3, after des2, 5d -Future task2 : des4, after des3, 5d -{{< /mermaid >}} - -## Pie chart - -{{< mermaid >}} -pie - title Key elements in Product X - "Calcium" : 42.96 - "Potassium" : 50.05 - "Magnesium" : 10.01 - "Iron" : 5 -{{< /mermaid >}} - -## Requirement Diagram - -```mermaid -requirementDiagram - - requirement test_req { - id: 1 - text: the test text. - risk: high - verifymethod: test - } - - element test_entity { - type: simulation - } - - test_entity - satisfies -> test_req - -``` - ## Requirements Doks uses npm to centralize dependency management, making it [easy to update]({{< relref "how-to-update" >}}) resources, build tooling, plugins, and build scripts: