Skip to content

Commit 83c1e8d

Browse files
authored
Add prettier ignore to Mermaid charts (tauri-apps#568)
* Add prettier ignore to Mermaid charts * Add in line breaks before and after comments
1 parent 631c9f6 commit 83c1e8d

File tree

8 files changed

+30
-2
lines changed

8 files changed

+30
-2
lines changed

.prettierignore

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
11
docs/api/cli.md
2-
docs/api/config.md
3-
docs/architecture/recipes/
2+
docs/api/config.md

docs/architecture/recipes/bridge.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@ The Bridge recipe is a secure pattern where messages are passed between brokers
5151

5252
import Mermaid, { colors } from '@theme/Mermaid'
5353

54+
<!-- prettier-ignore-start -->
55+
5456
<Mermaid chart={`graph TD
5557
H==>F
5658
subgraph WEBVIEW
@@ -78,9 +80,12 @@ import Mermaid, { colors } from '@theme/Mermaid'
7880
style RUST fill:${colors.orange.light},stroke:${colors.orange.dark},stroke-width:4px
7981
style WEBVIEW fill:${colors.blue.light},stroke:${colors.blue.dark},stroke-width:4px`} />
8082

83+
<!-- prettier-ignore-end -->
84+
8185
## Configuration
8286

8387
Here's what you need to add to your tauri.conf.json file:
88+
8489
```json
8590
{
8691
"tauri": {

docs/architecture/recipes/cloudbridge.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@ The Cloudbridge recipe combines the flexibility of a localhost and the security
5151

5252
import Mermaid, { colors } from '@theme/Mermaid'
5353

54+
<!-- prettier-ignore-start -->
55+
5456
<Mermaid chart={`graph TD
5557
H==>F2
5658
H==>D2
@@ -89,10 +91,12 @@ import Mermaid, { colors } from '@theme/Mermaid'
8991
style SERVER fill:#49A24A,stroke:#2B6063,stroke-width:4px
9092
`} />
9193

94+
<!-- prettier-ignore-end -->
9295

9396
## Configuration
9497

9598
Here's what you need to add to your tauri.conf.json file:
99+
96100
```json
97101
"tauri": {
98102
"allowlist": {

docs/architecture/recipes/cloudish.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@ The Cloudish recipe is a pattern for maximum flexibility and app performance. It
5151

5252
import Mermaid, { colors } from '@theme/Mermaid'
5353

54+
<!-- prettier-ignore-start -->
55+
5456
<Mermaid chart={`graph TD
5557
H==>F
5658
H==>D
@@ -75,10 +77,12 @@ import Mermaid, { colors } from '@theme/Mermaid'
7577
style WEBVIEW fill:${colors.blue.light},stroke:${colors.blue.dark},stroke-width:4px
7678
style SERVER fill:#49A24A,stroke:#2B6063,stroke-width:4px`} />
7779

80+
<!-- prettier-ignore-end -->
7881

7982
## Configuration
8083

8184
Here's what you need to add to your tauri.conf.json file:
85+
8286
```json
8387
"tauri": {
8488
"allowlist": {

docs/architecture/recipes/glui.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ The GLUI is a research pattern that we will use internally to test approaches us
5555

5656
import Mermaid, { colors } from '@theme/Mermaid'
5757

58+
<!-- prettier-ignore-start -->
59+
5860
<Mermaid chart={`graph TD
5961
A==>H
6062
H==>G
@@ -73,10 +75,12 @@ import Mermaid, { colors } from '@theme/Mermaid'
7375
style GLUTIN stroke:${colors.blue.dark},stroke-width:4px
7476
style RUST fill:${colors.orange.light},stroke:${colors.orange.dark},stroke-width:4px`} />
7577

78+
<!-- prettier-ignore-end -->
7679

7780
## Configuration
7881

7982
Here's what you need to add to your tauri.conf.json file:
83+
8084
```json
8185
"tauri": {
8286
"allowlist": { // all API endpoints are default false

docs/architecture/recipes/hermit.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@ The Hermit recipe is a pattern for ultimate application isolation where all logi
5151

5252
import Mermaid, { colors } from '@theme/Mermaid'
5353

54+
<!-- prettier-ignore-start -->
55+
5456
<Mermaid chart={`graph LR
5557
A==>H
5658
H==>F
@@ -66,6 +68,8 @@ import Mermaid, { colors } from '@theme/Mermaid'
6668
style RUST fill:${colors.orange.light},stroke:${colors.orange.dark},stroke-width:4px
6769
style WEBVIEW fill:${colors.blue.light},stroke:${colors.blue.dark},stroke-width:4px`} />
6870

71+
<!-- prettier-ignore-end -->
72+
6973
## Configuration
7074

7175
Here's what you need to add to your tauri.conf.json file:

docs/architecture/recipes/lockdown.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@ The Lockdown recipe is a minimal usage of the [Bridge pattern](./bridge.md), whi
5151

5252
import Mermaid, { colors } from '@theme/Mermaid'
5353

54+
<!-- prettier-ignore-start -->
55+
5456
<Mermaid chart={`graph TD
5557
H==>F
5658
G-.->B
@@ -70,6 +72,8 @@ import Mermaid, { colors } from '@theme/Mermaid'
7072
style RUST fill:${colors.orange.light},stroke:${colors.orange.dark},stroke-width:4px
7173
style WEBVIEW fill:${colors.blue.light},stroke:${colors.blue.dark},stroke-width:4px`} />
7274

75+
<!-- prettier-ignore-end -->
76+
7377
## Configuration
7478

7579
Here's what you need to add to your tauri.conf.json file:

docs/architecture/recipes/multiwin.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ The Multiwin recipe will allow you to have multiple windows.
5050

5151
import Mermaid, { colors } from '@theme/Mermaid'
5252

53+
<!-- prettier-ignore-start -->
54+
5355
<Mermaid chart={`graph LR
5456
A==>H
5557
H==>F
@@ -71,10 +73,12 @@ import Mermaid, { colors } from '@theme/Mermaid'
7173
style RUST fill:${colors.orange.light},stroke:${colors.orange.dark},stroke-width:4px
7274
style WEBVIEW fill:${colors.blue.light},stroke:${colors.blue.dark},stroke-width:4px`} />
7375

76+
<!-- prettier-ignore-end -->
7477

7578
## Configuration
7679

7780
Here's what you need to add to your tauri.conf.json file:
81+
7882
```json
7983
"tauri": {
8084
"allowlist": {}, // all API endpoints are default false

0 commit comments

Comments
 (0)