4206be2593
- Add `--rm` to auto-remove containers after exit - Add `-u $(id -u):$(id -g)` to run as host user (fixes PermissionError on Linux where container's UID 999 doesn't match host user) - Add `-e HOME=/tmp` so Typst can create its package cache when running as an arbitrary UID (without this, `rendercv render` fails) - Update both user guide and developer guide docs
2.1 KiB
Get Started
Installation
-
Install Python (3.12 or newer).
-
Run the command below to install RenderCV.
=== "pip"
``` pip install "rendercv[full]" ```=== "pipx"
``` pipx install "rendercv[full]" ```=== "uv"
``` uv tool install "rendercv[full]" ```=== "Docker"
Docker image is available at [ghcr.io/rendercv/rendercv](https://github.com/rendercv/rendercv/pkgs/container/rendercv). ```bash docker run --rm -v "$PWD":/work -u $(id -u):$(id -g) -e HOME=/tmp -w /work ghcr.io/rendercv/rendercv new "Your Name" ```
Quick Start
-
Create a new CV YAML input file
rendercv new "Your Name"This creates a YAML input file called
Your_Name_CV.yaml. This file contains the content, design options, translations and settings for RenderCV. See YAML Input Structure for the full reference.See the CLI Reference for the complete list of options available for the
newcommand.!!! tip To get started with another language or theme, you can use the
--localeand--themeoptions:```bash rendercv new "Your Name" --locale "turkish" --theme "engineeringresumes" ``` -
Render the YAML input file with
rendercv render "Your_Name_CV.yaml"This generates a
rendercv_output/directory containing:John_Doe_CV.pdf: Your CV as PDFJohn_Doe_CV.typ: Typst source code of the PDFJohn_Doe_CV_1.png,..._2.png, ...: PNG images of each page of the PDFJohn_Doe_CV.md: Your CV as MarkdownJohn_Doe_CV.html: Your CV as HTML (generated from the Markdown)
See the CLI Reference for the complete list of options available for the
rendercommand.!!! tip To re-render automatically whenever you save changes, use the
--watchoption:```bash rendercv render --watch "Your_Name_CV.yaml" ```