Skip to content

Commit 415b72f

Browse files
committed
Add diagrams for some workflow visualization
1 parent 5d47a9f commit 415b72f

2 files changed

Lines changed: 29 additions & 0 deletions

File tree

docs/configuration.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,16 @@ project/
1717
└── templates/
1818
```
1919

20+
## Configuration Workflow
21+
22+
```mermaid
23+
graph TD
24+
Main[Main config] -->|merge| Document[Document config]
25+
Document -->|merge| Page[Page config]
26+
Template[SVG Template] -.- Page
27+
Template -->|render| SVG[SVG Page]
28+
```
29+
2030
## Main Configuration File
2131

2232
| Option | Type | Default | Description |

docs/overview.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,25 @@ documents with minimal effort.
1313
- **Custom Processing**: Extend the processing workflow with Python
1414
- **PDF Compression**: Optional compression of final PDFs
1515

16+
```mermaid
17+
graph TD
18+
Main[Main config] -->|merge| Document[Document config]
19+
Document -->|merge| Page[Page config]
20+
Template[SVG Template] -.- Page
21+
Template -->|render| SVG[SVG Page]
22+
SVG -->|convert| PDF[PDF Page]
23+
24+
```
25+
26+
```mermaid
27+
graph LR
28+
Page1[PDF Page 1] -->|combine| Document[PDF Document]
29+
Page2[PDF Page 2] -->|combine| Document
30+
PageN[PDF Page ...] -->|combine| Document
31+
Document -.->|compress| Compressed[PDF Document compressed]
32+
linkStyle 3 stroke-dasharray: 5 5
33+
```
34+
1635
## Documentation
1736

1837
- [Configuration](configuration.md) - How to set up your documents

0 commit comments

Comments
 (0)