From 7db61ff6c21c49bc3f079990ffc63a49c22f25d0 Mon Sep 17 00:00:00 2001 From: esoubiran-aneo Date: Fri, 28 Apr 2023 16:21:39 +0200 Subject: [PATCH] docs: move file to understand mermaid to docs-theme --- .docs/content/2.guide/nice-charts-howto.md | 86 ---------------------- 1 file changed, 86 deletions(-) delete mode 100644 .docs/content/2.guide/nice-charts-howto.md diff --git a/.docs/content/2.guide/nice-charts-howto.md b/.docs/content/2.guide/nice-charts-howto.md deleted file mode 100644 index 011eeb618..000000000 --- a/.docs/content/2.guide/nice-charts-howto.md +++ /dev/null @@ -1,86 +0,0 @@ - - -[Mermaid](https://mermaid-js.github.io/mermaid/#/) is a JavaScript based diagramming and charting tool. Recently, -github added support to render mermaid code directly into the web browser. For example the code - -~~~text -```mermaid -stateDiagram - direction LR - [*] --> State1 - State1 --> [*]: A happy transition - State1 --> State2 - - %% This is how you declare composite states - state State2 { - [*] --> task_ready - task_ready --> CheckWhy: no - task_ready --> Continue: yes - } - State2 --> State2 - note left of State2 : A happy note - - %% This is how you make forks - state fork_state <> - State2 --> fork_state - fork_state --> fork1 - fork_state --> fork2 - - %% and how to merge them - state join_state <> - fork1 --> join_state - fork2 --> join_state - - %% And this how specify concurrency - state State3 { - [*]-->async1 - -- - [*]-->async2 - -- - [*]-->async3 - } - - join_state --> State3 - State3 --> [*] -``` -~~~ - -will be rendered as - - -stateDiagram - direction LR - [*] --> State1 - State1 --> [*]: A happy transition - State1 --> State2 - %% This is how you declare composite states - state State2 { - [*] --> task_ready - task_ready --> CheckWhy: no - task_ready --> Continue: yes - } - State2 --> State2 - note left of State2 : A happy note - %% This is how you make forks - state fork_state <> - State2 --> fork_state - fork_state --> fork1 - fork_state --> fork2 - %% and how to merge them - state join_state <> - fork1 --> join_state - fork2 --> join_state - %% And this how specify concurrency - state State3 { - [*]-->async1 - -- - [*]-->async2 - -- - [*]-->async3 - } - join_state --> State3 - State3 --> [*] - - -You can use [this live editor](https://mermaid.live) -to produce your charts and then just put them into a markdown file in your repository. Have fun :)