Skip to content

Commit 4316088

Browse files
xiaohanyuxiaohanyu
committed
docs: update compiler architecture graphs
1 parent e608133 commit 4316088

File tree

14 files changed

+320
-162
lines changed

14 files changed

+320
-162
lines changed

‎content/docs/compiler/architecture.mdx‎

Lines changed: 45 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ data from input to output with multiple phases.
1010
input files.
1111
- **Transformation Phase**: transforms the resume content and layout
1212
data with a pipeline.
13-
- **Codegen Phase**: renders the resume content and layout data using LaTeX
14-
templates.
15-
- **Output Phase**: generates the final PDF document.
13+
- **Codegen Phase**: renders the resume content and layout data using LaTeX,
14+
HTML, or Markdown templates.
15+
- **Output Phase**: generates the final PDF, HTML, or Markdown documents.
1616

1717
Here is a high-level architecture diagram of YAMLResume from 30000 feet:
1818

@@ -38,17 +38,31 @@ Here is a high-level architecture diagram of YAMLResume from 30000 feet:
3838
end
3939
4040
subgraph D[Codegen Phase]
41-
D1[Template renderer]
42-
D2[moderncv-banking]
43-
D3[moderncv-classic]
44-
D4[moderncv-casual]
45-
E1[LaTeX document]
41+
subgraph D1[HTML Engine]
42+
D1a[Template renderer]
43+
D1b[calm]
44+
D1c[vscode]
45+
D1d[HTML document]
46+
end
47+
subgraph D2[LaTeX Engine]
48+
D2a[Template renderer]
49+
D2b[moderncv-banking]
50+
D2c[moderncv-classic]
51+
D2d[moderncv-casual]
52+
D2e[LaTeX document]
53+
end
54+
subgraph D3[Markdown Engine]
55+
D3a[Template renderer]
56+
D3b[default]
57+
D3c[Markdown document]
58+
end
4659
end
4760
4861
subgraph E[Output Phase]
49-
F1[xetex]
50-
F2[tectonic]
51-
G[resume.pdf]
62+
E1[xetex -> resume.pdf]
63+
E2[tectonic -> resume.pdf]
64+
E3[HTML -> resume.html]
65+
E4[Markdown -> resume.md]
5266
end
5367
5468
A1 --> B1
@@ -60,24 +74,32 @@ Here is a high-level architecture diagram of YAMLResume from 30000 feet:
6074
C2 --> C3
6175
C3 --> C4
6276
C4 --> C5
63-
C5 --> D1
64-
D1 --> D2
65-
D1 --> D3
66-
D1 --> D4
67-
D2 --> E1
68-
D3 --> E1
69-
D4 --> E1
70-
E1 --> F1
71-
E1 --> F2
72-
F1 --> G
73-
F2 --> G
77+
C5 --> D1a
78+
C5 --> D2a
79+
C5 --> D3a
80+
D1a --> D1b
81+
D1a --> D1c
82+
D1b --> D1d
83+
D1c --> D1d
84+
D2a --> D2b
85+
D2a --> D2c
86+
D2a --> D2d
87+
D2b --> D2e
88+
D2c --> D2e
89+
D2d --> D2e
90+
D3a --> D3b
91+
D3b --> D3c
92+
D1d --> E3
93+
D2e --> E1
94+
D2e --> E2
95+
D3c --> E4
7496
7597
"/>
7698

7799
## Data Processing Pipeline
78100

79101
The transformation pipeline is responsible for processing raw resume data from
80-
YAML files and preparing it for LaTeX rendering. It operates in two main phases:
102+
YAML files and preparing it for rendering. It operates in two main phases:
81103
content transformation and layout transformation:
82104

83105
- The content transformation phase processes all textual data, applies

‎content/docs/compiler/index.mdx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ Key capabilities:
2626
Schema](https://json-schema.org)
2727
- Transform resume content data with a
2828
[pipeline](/docs/compiler/architecture#data-processing-pipeline)
29-
- Render content using [LaTeX templates](/docs/layouts/latex/templates)
29+
- Render content using [LaTeX layouts](/docs/layouts/latex), [HTML
30+
layouts](/docs/layouts/html), or [Markdown layout](/docs/layouts/markdown)
3031
- Generate PDFs via [XeTeX](/docs/installation#xetex) or
3132
[Tectonic](/docs/installation#tectonic) compilation engines
3233
- Support [multiple languages](/docs/locale) and localization

‎content/es/docs/compiler/architecture.mdx‎

Lines changed: 44 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ múltiples fases.
1212
- **Fase de Transformación**: transforma los datos de contenido y diseño del
1313
currículum con una tubería.
1414
- **Fase de Generación de Código**: renderiza los datos de contenido y diseño
15-
del currículum usando plantillas LaTeX.
16-
- **Fase de Salida**: genera el documento PDF final.
15+
del currículum usando plantillas LaTeX, HTML o Markdown.
16+
- **Fase de Salida**: genera los documentos finales PDF, HTML o Markdown.
1717

1818
Aquí hay un diagrama de arquitectura de alto nivel de YAMLResume desde 30000
1919
pies:
@@ -40,17 +40,31 @@ pies:
4040
end
4141
4242
subgraph D[Fase de Generación de Código]
43-
D1[Renderizador de plantillas]
44-
D2[moderncv-banking]
45-
D3[moderncv-classic]
46-
D4[moderncv-casual]
47-
E1[Documento LaTeX]
43+
subgraph D1[Motor HTML]
44+
D1a[Renderizador de plantillas]
45+
D1b[calm]
46+
D1c[vscode]
47+
D1d[Documento HTML]
48+
end
49+
subgraph D2[Motor LaTeX]
50+
D2a[Renderizador de plantillas]
51+
D2b[moderncv-banking]
52+
D2c[moderncv-classic]
53+
D2d[moderncv-casual]
54+
D2e[Documento LaTeX]
55+
end
56+
subgraph D3[Motor Markdown]
57+
D3a[Renderizador de plantillas]
58+
D3b[default]
59+
D3c[Documento Markdown]
60+
end
4861
end
4962
5063
subgraph E[Fase de Salida]
51-
F1[xetex]
52-
F2[tectonic]
53-
G[resume.pdf]
64+
E1[xetex -> resume.pdf]
65+
E2[tectonic -> resume.pdf]
66+
E3[HTML -> resume.html]
67+
E4[Markdown -> resume.md]
5468
end
5569
5670
A1 --> B1
@@ -62,24 +76,32 @@ pies:
6276
C2 --> C3
6377
C3 --> C4
6478
C4 --> C5
65-
C5 --> D1
66-
D1 --> D2
67-
D1 --> D3
68-
D1 --> D4
69-
D2 --> E1
70-
D3 --> E1
71-
D4 --> E1
72-
E1 --> F1
73-
E1 --> F2
74-
F1 --> G
75-
F2 --> G
79+
C5 --> D1a
80+
C5 --> D2a
81+
C5 --> D3a
82+
D1a --> D1b
83+
D1a --> D1c
84+
D1b --> D1d
85+
D1c --> D1d
86+
D2a --> D2b
87+
D2a --> D2c
88+
D2a --> D2d
89+
D2b --> D2e
90+
D2c --> D2e
91+
D2d --> D2e
92+
D3a --> D3b
93+
D3b --> D3c
94+
D1d --> E3
95+
D2e --> E1
96+
D2e --> E2
97+
D3c --> E4
7698
7799
"/>
78100

79101
## Tubería de Procesamiento de Datos
80102

81103
La tubería de transformación es responsable de procesar los datos crudos del
82-
currículum desde archivos YAML y prepararlos para el renderizado LaTeX. Opera en
104+
currículum desde archivos YAML y prepararlos para el renderizado. Opera en
83105
dos fases principales: transformación de contenido y transformación de diseño:
84106

85107
- La fase de transformación de contenido procesa todos los datos textuales,

‎content/es/docs/compiler/index.mdx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ Capacidades clave:
2828
Schema](https://json-schema.org)
2929
- Transforma los datos del contenido del currículum con una
3030
[tubería](/docs/compiler/architecture#data-processing-pipeline)
31-
- Renderiza el contenido usando [plantillas LaTeX](/docs/layouts/latex/templates)
31+
- Renderiza el contenido usando [layouts LaTeX](/docs/layouts/latex), [layouts
32+
HTML](/docs/layouts/html) o [layout Markdown](/docs/layouts/markdown)
3233
- Genera PDFs vía motores de compilación [XeTeX](/docs/installation#xetex) o
3334
[Tectonic](/docs/installation#tectonic)
3435
- Soporta [múltiples idiomas](/docs/locale) y localización

‎content/fr/docs/compiler/architecture.mdx‎

Lines changed: 44 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ données de CV d'entrée vers la sortie avec plusieurs phases.
1111
- **Phase de Transformation** : transforme le contenu et les données de mise en page
1212
du CV avec un pipeline.
1313
- **Phase de Génération de Code** : rend le contenu et les données de mise en page du CV en utilisant des
14-
modèles LaTeX.
15-
- **Phase de Sortie** : génère le document PDF final.
14+
modèles LaTeX, HTML ou Markdown.
15+
- **Phase de Sortie** : génère les documents finaux PDF, HTML ou Markdown.
1616

1717
Voici un diagramme d'architecture de haut niveau de YAMLResume depuis 30 000 pieds :
1818

@@ -38,17 +38,31 @@ Voici un diagramme d'architecture de haut niveau de YAMLResume depuis 30 000 pie
3838
end
3939
4040
subgraph D[Phase de Génération de Code]
41-
D1[Rendu de modèle]
42-
D2[moderncv-banking]
43-
D3[moderncv-classic]
44-
D4[moderncv-casual]
45-
E1[Document LaTeX]
41+
subgraph D1[Moteur HTML]
42+
D1a[Rendu de modèle]
43+
D1b[calm]
44+
D1c[vscode]
45+
D1d[Document HTML]
46+
end
47+
subgraph D2[Moteur LaTeX]
48+
D2a[Rendu de modèle]
49+
D2b[moderncv-banking]
50+
D2c[moderncv-classic]
51+
D2d[moderncv-casual]
52+
D2e[Document LaTeX]
53+
end
54+
subgraph D3[Moteur Markdown]
55+
D3a[Rendu de modèle]
56+
D3b[default]
57+
D3c[Document Markdown]
58+
end
4659
end
4760
4861
subgraph E[Phase de Sortie]
49-
F1[xetex]
50-
F2[tectonic]
51-
G[resume.pdf]
62+
E1[xetex -> resume.pdf]
63+
E2[tectonic -> resume.pdf]
64+
E3[HTML -> resume.html]
65+
E4[Markdown -> resume.md]
5266
end
5367
5468
A1 --> B1
@@ -60,24 +74,32 @@ Voici un diagramme d'architecture de haut niveau de YAMLResume depuis 30 000 pie
6074
C2 --> C3
6175
C3 --> C4
6276
C4 --> C5
63-
C5 --> D1
64-
D1 --> D2
65-
D1 --> D3
66-
D1 --> D4
67-
D2 --> E1
68-
D3 --> E1
69-
D4 --> E1
70-
E1 --> F1
71-
E1 --> F2
72-
F1 --> G
73-
F2 --> G
77+
C5 --> D1a
78+
C5 --> D2a
79+
C5 --> D3a
80+
D1a --> D1b
81+
D1a --> D1c
82+
D1b --> D1d
83+
D1c --> D1d
84+
D2a --> D2b
85+
D2a --> D2c
86+
D2a --> D2d
87+
D2b --> D2e
88+
D2c --> D2e
89+
D2d --> D2e
90+
D3a --> D3b
91+
D3b --> D3c
92+
D1d --> E3
93+
D2e --> E1
94+
D2e --> E2
95+
D3c --> E4
7496
7597
"/>
7698

7799
## Pipeline de Traitement des Données
78100

79101
Le pipeline de transformation est responsable du traitement des données brutes de CV à partir
80-
des fichiers YAML et de leur préparation pour le rendu LaTeX. Il fonctionne en deux phases principales :
102+
des fichiers YAML et de leur préparation pour le rendu. Il fonctionne en deux phases principales :
81103
transformation du contenu et transformation de la mise en page :
82104

83105
- La phase de transformation du contenu traite toutes les données textuelles, applique

‎content/fr/docs/compiler/index.mdx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ Capacités clés :
2626
Schema](https://json-schema.org)
2727
- Transforme les données de contenu du CV avec un
2828
[pipeline](/fr/docs/compiler/architecture#data-processing-pipeline)
29-
- Rend le contenu en utilisant des [modèles LaTeX](/fr/docs/layouts/latex/templates)
29+
- Rend le contenu en utilisant des [layouts LaTeX](/fr/docs/layouts/latex),
30+
[layouts HTML](/fr/docs/layouts/html) ou [layout Markdown](/fr/docs/layouts/markdown)
3031
- Génère des PDF via les moteurs de compilation [XeTeX](/fr/docs/installation#xetex) ou
3132
[Tectonic](/fr/docs/installation#tectonic)
3233
- Supporte [plusieurs langues](/fr/docs/locale) et la localisation

0 commit comments

Comments
 (0)