Skip to content

pdf_png

copy_photo_next_to_typst_file(rendercv_model, typst_path)

Copy CV photo to Typst file directory for compilation.

Why

Typst compiler resolves image paths relative to source file location. Copying photo ensures compilation succeeds regardless of original photo location.

Parameters:

  • rendercv_model (RenderCVModel) –

    CV model containing photo path.

  • typst_path (Path) –

    Path to Typst source file.

Source code in src/rendercv/renderer/pdf_png.py 
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
def copy_photo_next_to_typst_file(
    rendercv_model: RenderCVModel, typst_path: pathlib.Path
) -> None:
    """Copy CV photo to Typst file directory for compilation.

    Why:
        Typst compiler resolves image paths relative to source file location.
        Copying photo ensures compilation succeeds regardless of original
        photo location.

    Args:
        rendercv_model: CV model containing photo path.
        typst_path: Path to Typst source file.
    """
    if rendercv_model.cv.photo:
        photo_path = rendercv_model.cv.photo
        copy_to = typst_path.parent / photo_path.name
        if photo_path != copy_to:
            shutil.copy(
                rendercv_model.cv.photo,
                typst_path.parent / rendercv_model.cv.photo.name,
            )

generate_pdf(rendercv_model, typst_path)

Compile Typst source to PDF using typst-py compiler.

Why

PDF is the primary output format for CVs. Typst compilation produces high-quality PDFs with proper fonts, layout, and typography from the intermediate Typst markup.

Parameters:

  • rendercv_model (RenderCVModel) –

    CV model for path resolution and photo handling.

  • typst_path (Path | None) –

    Path to Typst source file to compile.

Returns:

  • Path | None –

    Path to generated PDF file, or None if generation disabled.

Source code in src/rendercv/renderer/pdf_png.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
def generate_pdf(
    rendercv_model: RenderCVModel, typst_path: pathlib.Path | None
) -> pathlib.Path | None:
    """Compile Typst source to PDF using typst-py compiler.

    Why:
        PDF is the primary output format for CVs. Typst compilation produces
        high-quality PDFs with proper fonts, layout, and typography from the
        intermediate Typst markup.

    Args:
        rendercv_model: CV model for path resolution and photo handling.
        typst_path: Path to Typst source file to compile.

    Returns:
        Path to generated PDF file, or None if generation disabled.
    """
    if rendercv_model.settings.render_command.dont_generate_pdf or typst_path is None:
        return None
    pdf_path = resolve_rendercv_file_path(
        rendercv_model, rendercv_model.settings.render_command.pdf_path
    )
    typst_compiler = get_typst_compiler(typst_path, rendercv_model._input_file_path)
    copy_photo_next_to_typst_file(rendercv_model, typst_path)
    typst_compiler.compile(format="pdf", output=pdf_path)

    return pdf_path

generate_png(rendercv_model, typst_path)

Compile Typst source to PNG images using typst-py compiler.

Why

PNG format enables CV preview in web applications and README files. Multi-page CVs produce multiple PNG files with sequential numbering.

Parameters:

  • rendercv_model (RenderCVModel) –

    CV model for path resolution and photo handling.

  • typst_path (Path | None) –

    Path to Typst source file to compile.

Returns:

  • list[Path] | None –

    List of paths to generated PNG files, or None if generation disabled.

Source code in src/rendercv/renderer/pdf_png.py 
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
def generate_png(
    rendercv_model: RenderCVModel, typst_path: pathlib.Path | None
) -> list[pathlib.Path] | None:
    """Compile Typst source to PNG images using typst-py compiler.

    Why:
        PNG format enables CV preview in web applications and README files.
        Multi-page CVs produce multiple PNG files with sequential numbering.

    Args:
        rendercv_model: CV model for path resolution and photo handling.
        typst_path: Path to Typst source file to compile.

    Returns:
        List of paths to generated PNG files, or None if generation disabled.
    """
    if rendercv_model.settings.render_command.dont_generate_png or typst_path is None:
        return None
    png_path = resolve_rendercv_file_path(
        rendercv_model, rendercv_model.settings.render_command.png_path
    )
    typst_compiler = get_typst_compiler(typst_path, rendercv_model._input_file_path)
    copy_photo_next_to_typst_file(rendercv_model, typst_path)
    png_files_bytes = typst_compiler.compile(format="png")

    if not isinstance(png_files_bytes, list):
        png_files_bytes = [png_files_bytes]

    png_files = []
    for i, png_file_bytes in enumerate(png_files_bytes):
        assert png_file_bytes is not None
        png_file = png_path.parent / (png_path.stem + f"_{i + 1}.png")
        png_file.write_bytes(png_file_bytes)
        png_files.append(png_file)

    return png_files if png_files else None

get_typst_compiler(file_path, input_file_path) cached

Create cached Typst compiler with font paths configured.

Why

Compiler initialization is expensive. Caching enables reuse for both PDF and PNG generation. Font paths include package fonts and optional user fonts from input file directory.

Parameters:

  • file_path (Path) –

    Typst source file to compile.

  • input_file_path (Path | None) –

    Original input file path for relative font resolution.

Returns:

  • Compiler –

    Configured Typst compiler instance.

Source code in src/rendercv/renderer/pdf_png.py 
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
@functools.lru_cache(maxsize=1)
def get_typst_compiler(
    file_path: pathlib.Path,
    input_file_path: pathlib.Path | None,
) -> typst.Compiler:
    """Create cached Typst compiler with font paths configured.

    Why:
        Compiler initialization is expensive. Caching enables reuse for both
        PDF and PNG generation. Font paths include package fonts and optional
        user fonts from input file directory.

    Args:
        file_path: Typst source file to compile.
        input_file_path: Original input file path for relative font resolution.

    Returns:
        Configured Typst compiler instance.
    """
    return typst.Compiler(
        file_path,
        font_paths=[
            *rendercv_fonts.paths_to_font_folders,
            (
                input_file_path.parent / "fonts"
                if input_file_path
                else pathlib.Path.cwd() / "fonts"
            ),
        ],
    )