4331110c55
* prepare the base for typst * rename theme folders * rename themes * rename themes * update testdata with new theme names * rename themes * fix docs issues * fundamentals * fundamental renames * generalize `create_a_latex_file` * generalize render_a_pdf_from_latex * make latex optional dependency, and add typst as dependency * first tests with typst * finish `markdown_to_typst` * fix `markdown_to_latex` * finish `markdown_to_typst` * first steps towards Typst RenderCV themes * first draft of classic theme * start working on new design options * work on new design options * make default theme: "classic" * start integrating design options with templates * rename typst variables * start working on connections integration * polish connections * polish design options and themes * fix spelling mistakes and improve typst themes * use ms instead of s in printer * improve templates * fix typos * use ms instead of s in printer * improve typst templates * improve * improve * improve * improve * make PyMuPDF optional * rename last_updated_date_style to last_updated_date_template * revert changelog * progress * improve * exclude gifs from sdist * update tests * improve templates * improve templater * data: update `sample_content.yaml` * improve * remove latex support * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * remove testdata * remove latex * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * rename `locale_catalog` to `locale` * docs: update developer guide faq * add new input, rendercv_settings.date * add show_time_span_in * create a new function, parse_validation_errors * improve templates * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * improve * update templates * fix experience entry * improve * finish templates * update tests * update testdata * remove time_machine * update sample content * improve * add sb2nov theme * update options * update theme.options * update theme.options * update theme options * create engineeringresumes templates * add engineering resumes * format * update templates * add new theme * fix a typo in sample content * update templating system * update options * add photo support * update workflows * improve templates * improve parse_validation_errors * create a new interface for web * fix summary * improve * resolve typing issues * update mkdocs.yaml * update pyproject.toml * update docs scripts * update testdata * update tests * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * rename column template fields * update * update test data * add moderncv * fix problems * moderncv * create moderncv * fix tests * update * update * update templates * update * use optional dependencies * fix * improve * aa * a * update * update * update * update * rename * update * update * update * improve * update * update * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * update * update * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * format * update changelog * update examples * update entry figures * update schema --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
3.0 KiB
User Guide
This page provides everything you need to know about the usage of RenderCV.
Installation
-
Install Python (3.10 or newer).
-
Run the command below to install RenderCV.
pip install "rendercv[full]"
Getting started
To get started, navigate to the directory where you want to create your CV and run the command below to create the input files.
rendercv new "Your Full Name"
This command will create the following files:
-
A YAML input file called
Your_Name_CV.yaml.This file contains the content and design options of your CV. A detailed explanation of the structure of the YAML input file is provided here.
-
A directory called
classic.This directory contains the Typst templates of RenderCV's default built-in theme,
classic. You can update its contents to tweak the appearance of the output PDF file. -
A directory called
markdown.This directory contains the templates of RenderCV's default Markdown template. You can update its contents to tweak the Markdown and HTML output of the CV.
!!! note "A note about classic and markdown directories"
It's optional to have the classic and markdown directories. If you don't have them, RenderCV will use the built-in theme and Markdown templates.
!!! info
Refer to the here for the complete list of CLI options available for the new command.
Then, open the Your_Name_CV.yaml file in your favorite text editor and fill it with your information. See the structure of the YAML input file for more information about the YAML input file.
Finally, render the YAML input file to generate your CV.
rendercv render "Your_Name_CV.yaml"
This command will generate a directory called rendercv_output, which contains the following files:
- The CV in PDF format,
Your_Name_CV.pdf. - Typst source code of the PDF file,
Your_Name_CV.typ. - Images of each page of the PDF file in PNG format,
Your_Name_CV_1.png,Your_Name_CV_page_2.png, etc. - The CV in Markdown format,
Your_Name_CV.md. - The CV in HTML format,
Your_Name_CV.html. You can open this file in a web browser and copy-paste the content to Grammarly for proofreading.
!!! info
Refer to the here for the complete list of CLI options available for the render command.
Overriding built-in themes
If the theme and Markdown templates are found in the directory, they will override the default built-in theme and Markdown templates. You don't need to provide all the files; you can just provide the ones you want to override.
For example, ExperienceEntry of the classic theme can be modified as shown below.
├── classic
│ └── ExperienceEntry.j2.typ # (1)!
└── Your_Full_Name_CV.yaml
- This file will override the built-in
ExperienceEntry.j2.typtemplate of theclassictheme.