You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/configuration.md
+15-5Lines changed: 15 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,12 +19,22 @@ project/
19
19
20
20
## Configuration Workflow
21
21
22
+
For every page, your main configuration (for all documents), document configuration (for all pages of this document) and the page configuration are merged to form the context provided to your page template.
Settings in the main configuration are available to all documents.<br>Settings in a document configuration are available to all of its pages.<br>Each page configuration can hold page-specific settings/content, so that the template of page is only responsible for layout/design.
56
+
57
+
```mermaid
58
+
flowchart TD
59
+
subgraph Configuration
60
+
Main[YAML Main Config] -->|inherits| Doc[YAML Document Config]
61
+
Doc -->|inherits| Page[YAML Page Config]
62
+
end
63
+
64
+
subgraph Page Processing
65
+
Template[SVG Template]
66
+
Page -->|context| Render[Template Rendering]
67
+
Template -->|jinja2| Render
68
+
Render -->|output| SVG[SVG File]
69
+
SVG -->|cairosvg| PDF[PDF File]
70
+
end
24
71
```
25
72
73
+
### Pages make up a document
74
+
75
+
After each page template was rendered and the resulting SVG file converted to PDF, these page PDFs are combined to create the document.<br>This may optionally get compressed for a nice end result.
0 commit comments