Skip to content

Commit 2447354

Browse files
add plugin commit test doc
1 parent a087605 commit 2447354

File tree

4 files changed

+91
-3
lines changed

4 files changed

+91
-3
lines changed

docs/cdk/test.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
2+
3+
```mermaid
4+
graph LR
5+
A[Start] --> B{Error?};
6+
B -->|Yes| C[Hmm...];
7+
C --> D[Debug];
8+
D --> B;
9+
B ---->|No| E[Yay!];
10+
```
11+
12+
13+
``` mermaid
14+
sequenceDiagram
15+
autonumber
16+
Alice->>John: Hello John, how are you?
17+
loop Healthcheck
18+
John->>John: Fight against hypochondria
19+
end
20+
Note right of John: Rational thoughts!
21+
John-->>Alice: Great!
22+
John->>Bob: How about you?
23+
Bob-->>John: Jolly good!
24+
```
25+
26+
27+
``` mermaid
28+
stateDiagram-v2
29+
state fork_state <<fork>>
30+
[*] --> fork_state
31+
fork_state --> State2
32+
fork_state --> State3
33+
34+
state join_state <<join>>
35+
State2 --> join_state
36+
State3 --> join_state
37+
join_state --> State4
38+
State4 --> [*]
39+
```
40+
41+
42+
``` mermaid
43+
classDiagram
44+
Person <|-- Student
45+
Person <|-- Professor
46+
Person : +String name
47+
Person : +String phoneNumber
48+
Person : +String emailAddress
49+
Person: +purchaseParkingPass()
50+
Address "1" <-- "0..1" Person:lives at
51+
class Student{
52+
+int studentNumber
53+
+int averageMark
54+
+isEligibleToEnrol()
55+
+getSeminarsTaken()
56+
}
57+
class Professor{
58+
+int salary
59+
}
60+
class Address{
61+
+String street
62+
+String city
63+
+String state
64+
+int postalCode
65+
+String country
66+
-validate()
67+
+outputAsLabel()
68+
}
69+
```
70+
71+
72+
``` mermaid
73+
erDiagram
74+
CUSTOMER ||--o{ ORDER : places
75+
ORDER ||--|{ LINE-ITEM : contains
76+
LINE-ITEM {
77+
string name
78+
int pricePerUnit
79+
}
80+
CUSTOMER }|..|{ DELIVERY-ADDRESS : uses
81+
```

docs/pos/get-started/building-on-polygon.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,4 +101,4 @@ main();
101101
If you already have a decentralized application (dApp) and are looking for a platform to help you scale efficiently, then you are at the right place because Polygon allows you to:
102102

103103
1. Easily migrate from Ethereum Virtual Machine (EVM) based chain: Polygon prides itself in being the ultimate Layer-2 scaling solution for Ethereum. You don't have to worry about the underlying architecture while moving or deploying your dApps to the Polygon PoS network as long as it is EVM-compatible.
104-
2. Use Polygon PoS as a faster transaction layer: Deploying your dApp to the PoS mainnet allows you to leverage Polygon as a faster transaction layer for your dApp. Additionally, you can get your tokens mapped by us. You can join our [technical discussions group](http://bit.ly/matic-technical-group) on Telegram to learn more.
104+
2. Use Polygon PoS as a faster transaction layer: Deploying your dApp to the PoS mainnet allows you to leverage Polygon as a faster transaction layer for your dApp. Additionally, you can get your tokens mapped by us. You can join our [technical discussions group](http://bit.ly/matic-technical-group) on Telegram to learn more.

mkdocs.yml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ nav:
5252
- Home: index.md
5353
- CDK:
5454
- CDK: cdk/index.md
55+
- Test: cdk/test.md
5556
- Overview: cdk/overview.md
5657
- Releases:
5758
- Version compatibility matrix: cdk/version-matrix.md
@@ -661,7 +662,12 @@ markdown_extensions:
661662
- pymdownx.caret
662663
- meta
663664
- smarty
664-
- pymdownx.extra
665+
- pymdownx.extra:
666+
pymdownx.superfences:
667+
custom_fences:
668+
- name: mermaid
669+
class: mermaid
670+
format: !!python/name:pymdownx.superfences.fence_code_format
665671

666672
plugins:
667673
- multirepo:

requirements.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@ mkdocs-material==9.4.8
22
markdown-include==0.8.1
33
mkdocs-open-in-new-tab==1.0.3
44
mkdocs-multirepo-plugin==0.7.0
5-
mkdocs-redirects==1.2.1
5+
mkdocs-redirects==1.2.1
6+
mkdocs-mermaid2-plugin==1.1.1

0 commit comments

Comments
 (0)