home | heroText | tagline | footer |
---|---|---|---|
true |
VuePress |
Diagrams quickstart |
Made by Maksim Kostromin with ❤️ 🤘 |
Quick and fast rapid VuePress documentation diagrams development [[toc]]
<mermaid>
classDiagram
Class01 <|-- AveryLongClass : Cool
Class03 *-- Class04
Class05 o-- Class06
Class07 .. Class08
Class09 --> C2 : Where am i?
Class09 --* C3
Class09 --|> Class07
Class07 : equals()
Class07 : Object[] elementData
Class01 : size()
Class01 : int chimp
Class01 : int gorilla
Class08 <--> C2: Cool label
</mermaid>
<mermaid>
graph TD
A[Silvester] -->|Get money| B(Go shopping)
B --> C{Let me think}
C -->|One| D[Laptop]
C -->|Two| E[iPhone]
C -->|Three| F[Car]
C -->|Four| F[Mac]
</mermaid>
<mermaid>
sequenceDiagram
Alice->>Bob: Hello Bob, how are you?
alt is sick
Bob->>Alice: Not so good :(
else is well
Bob->>Alice: Feeling fresh like a daisy
end
opt Extra response
Bob->>Alice: Thanks for asking
end
</mermaid>
<mermaid>
gantt
section Section
Completed :done, des1, 2014-01-06, 2014-01-08
Active :active, des2, 2014-01-07, 3d
Parallel 1 : des3, after des1, 1d
Parallel 2 : des4, after des1, 1d
Parallel 3 : des5, after des3, 1d
Parallel 4 : des6, after des4, 1d
</mermaid>
<mermaid>
stateDiagram
[*] --> Still
Still --> [*]
Still --> Moving
Moving --> Still
Moving --> Crash
Crash --> [*]
</mermaid>
@startuml
Bob -> Alice : hello
@enduml
<br/>
@startuml
Bob -> Alice : hello
@enduml
@startuml
@startmindmap
title My super title
* <&flag>Debian
** <&globe>Ubuntu
*** Linux Mint
*** Kubuntu
*** Lubuntu
*** KDE Neon
** <&graph>LMDE
** <&pulse>SolydXK
** <&people>SteamOS
** <&star>Raspbian with a very long name
*** <s>Raspmbc</s> => OSMC
*** <s>Raspyfi</s> => Volumio
caption figure 1
@endmindmap
@enduml
<br/>
@startuml @startmindmap
title My super title
- <&flag>Debian
** <&globe>Ubuntu
*** Linux Mint
*** Kubuntu
*** Lubuntu
*** KDE Neon
** <&graph>LMDE
** <&pulse>SolydXK
** <&people>SteamOS
** <&star>Raspbian with a very long name
***
Raspmbc=> OSMC ***Raspyfi=> Volumio
caption figure 1
@endmindmap
@enduml
@startuml
node in as "input"
node p as "Pre-processing"
node fm as "Feature Mining"
node fs as "Feature Selection"
node fr as "Feature Reduction"
node m as "Modelling"
node a as "Accepted Results?"
node pp as "Post-processing"
node o as "Output"
in -> p
p ..> fm
fm ..> fs
fs ..> fr
fr ..> m
m ..> a
a ..> fm : no
a -> pp : yes
pp -> o
@enduml
@startuml node in as "input" node p as "Pre-processing" node fm as "Feature Mining" node fs as "Feature Selection" node fr as "Feature Reduction" node m as "Modelling" node a as "Accepted Results?" node pp as "Post-processing" node o as "Output"
in -> p p ..> fm fm ..> fs fs ..> fr fr ..> m m ..> a a ..> fm : no a -> pp : yes pp -> o @enduml
@startuml
|Required Steps|
:"Start Assignment";
|#AntiqueWhite|Documentation|
:Create Git Repo/Overleaf;
:Copy Down Questions;
|#LightBlue|Git|
:Initial Barebones Commit;
|Required Steps|
:"Answer Questions";
:"Submit Assignment";
|Git|
:"Update Local Repo";
:"Update CENG4B Notes;
stop
@enduml
@startuml |Required Steps| :"Start Assignment"; |#AntiqueWhite|Documentation| :Create Git Repo/Overleaf; :Copy Down Questions; |#LightBlue|Git| :Initial Barebones Commit; |Required Steps| :"Answer Questions"; :"Submit Assignment"; |Git| :"Update Local Repo"; :"Update CENG4B Notes; stop @enduml
@startuml
(*) --> [File System ] "input.json "
note left
1. Read Entire File into memory
end note
-->[Available Memory]"JSON data loaded in memory"
note left
2. Process file
in memory.
end note
note right
When loading a file into
memory to be parsed as
JSON or CSV, we’re limited
by the max string size
in Node.js: around 536 MB
as of Node v8
end note
--> [File System] "output.json"
note left
3. Write transform data back into system
end note
--> (*)
@enduml
@startuml (*) --> [File System ] "input.json " note left
- Read Entire File into memory end note -->[Available Memory]"JSON data loaded in memory" note left
- Process file in memory. end note note right When loading a file into memory to be parsed as JSON or CSV, we’re limited by the max string size in Node.js: around 536 MB as of Node v8 end note --> [File System] "output.json" note left
- Write transform data back into system end note --> (*) @enduml
@startuml
digraph foo {
node [style=rounded]
node1 [shape=box]
node2 [fillcolor=yellow, style="rounded,filled", shape=diamond]
node3 [shape=record, label="{ a | b | c }"]
node1 -> node2 -> node3
}
@enduml
@startuml digraph foo { node [style=rounded] node1 [shape=box] node2 [fillcolor=yellow, style="rounded,filled", shape=diamond] node3 [shape=record, label="{ a | b | c }"]
node1 -> node2 -> node3 } @enduml
@startuml
strict digraph cool {
exists [color=blue]
authenticate [color=blue]
require
create
UserCreated
destroy
UserDestroyed
get [color=blue]
authenticate -> require
create -> UserCreated
destroy -> require
destroy -> UserDestroyed
get -> require
}
@enduml
@startuml strict digraph cool { exists [color=blue] authenticate [color=blue] require create UserCreated destroy UserDestroyed get [color=blue] authenticate -> require create -> UserCreated destroy -> require destroy -> UserDestroyed get -> require } @enduml
<bar-chart :data="[
['Assignments', 10],
['Midterm', 35],
['Final', 55]]"
/>
<pie-chart :data="[
['Assignments', 10],
['Midterm', 35],
['Final', 55]]"
/>
<column-chart :data="[
['Assignments', 10],
['Midterm', 35],
['Final', 55]]"
/>
another sample
<column-chart :data="[
['Sun', 32],
['Mon', 46],
['Tue', 28],
]"/>
<area-chart :data="[
['Assignments', 10],
['Midterm', 35],
['Final', 55]
]" />
another sample
<area-chart :data="{
'2017-01-01': 11,
'2017-01-02': 6,
'2017-01-03': 7,
'2017-01-04': 8,
'2017-01-05': 3,
}" />
<scatter-chart
xtitle="Size"
ytitle="Population"
:data="[
[175.0, 80.0],
[175.3, 60.1],
[175.5, 55.2],
[175.8, 42.4],
[176.0, 38.3],
]"
/>
<line-chart :data="[
{ name: 'Workout', data: { '2017-01-01': 3, '2017-01-02': 4 } },
{ name: 'Call parents', data: { '2017-01-01': 5, '2017-01-02': 3 } },
]" />
$x^2 + x_2 = x_2 + x^2$
yet another sample
$$x^2 + x = x + x^2$$
Start from documentation:
mkdir /tmp/1 && wget -qO- https://github.com/daggerok/vuepress-diagrams/archive/master.zip | tar xvf - -C $_
# wget -qO- https://github.com/daggerok/vuepress-diagrams/archive/master.zip | tar xvf -
# tar -xvf <(curl -sL https://github.com/daggerok/vuepress-diagrams/archive/master.zip)
# jar -xvf <(curl -sL https://github.com/daggerok/vuepress-diagrams/archive/master.zip)
mv /tmp/1/vuepress-diagrams-master /tmp/my-new-project
cd /tmp/my-new-project/
# find and replace: vuepress-diagrams -> my-new-project
# such as: BASE='/my-new-project/'
vi package.json
vi .vuepress/config.js
npm i -E ; npm run build ; npx serve .vuepress/dist/
open http://localhost:8080/ url
Checkout .github/workflows/ci.yaml
file to see how easily you can deploy your VuePress docs on GitHub Pages:
@code transcludeWith=::include lang=yaml
That README.md documentation file is compiled and deployed on GitHub Pages