https://github.com/rendercv/rendercv
The engine of the RenderCV App
https://github.com/rendercv/rendercv
cv cv-builder cv-generator cv-template python resume resume-builder resume-generator resume-template typst
Last synced: 5 months ago
JSON representation
The engine of the RenderCV App
- Host: GitHub
- URL: https://github.com/rendercv/rendercv
- Owner: rendercv
- License: mit
- Created: 2023-06-11T13:58:25.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-05T21:08:51.000Z (5 months ago)
- Last Synced: 2025-05-05T22:25:34.491Z (5 months ago)
- Topics: cv, cv-builder, cv-generator, cv-template, python, resume, resume-builder, resume-generator, resume-template, typst
- Language: Python
- Homepage: https://docs.rendercv.com
- Size: 199 MB
- Stars: 2,618
- Watchers: 8
- Forks: 240
- Open Issues: 68
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yaml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
- StarryDivineSky - rendercv/rendercv
README
RenderCV
_The engine of the [RenderCV App](https://rendercv.com)_
[](https://github.com/rendercv/rendercv/actions/workflows/test.yaml)
[](https://coverage-badge.samuelcolvin.workers.dev/redirect/rendercv/rendercv)
[![docs]()](https://docs.rendercv.com)
[![pypi-version]()](https://pypi.python.org/pypi/rendercv)
[![pypi-downloads]()](https://pypistats.org/packages/rendercv)
RenderCV engine is a Typst-based Python package with a command-line interface (CLI) that allows you to version-control your CV/resume as source code. It reads a CV written in a YAML file with Markdown syntax, converts it into a [Typst](https://typst.app) code, and generates a PDF.
RenderCV engine's focus is to provide these three features:
- **Content-first approach:** Users should be able to focus on the content instead of worrying about the formatting.
- **A mechanism to version-control a CV's content and design separately:** The content and design of a CV are separate issues and they should be treated separately.
- **Robustness:** A PDF should be delivered if there aren't any errors. If errors exist, they should be clearly explained along with solutions.
It takes a YAML file that looks like this:
```yaml
cv:
name: John Doe
location: Location
email: john.doe@example.com
phone: tel:+1-609-999-9995
social_networks:
- network: LinkedIn
username: john.doe
- network: GitHub
username: john.doe
sections:
welcome_to_RenderCV!:
- '[RenderCV](https://rendercv.com) is a Typst-based CV
framework designed for academics and engineers, with Markdown
syntax support.'
- Each section title is arbitrary. Each section contains
a list of entries, and there are 7 different entry types
to choose from.
education:
- institution: Stanford University
area: Computer Science
degree: PhD
location: Stanford, CA, USA
start_date: 2023-09
end_date: present
highlights:
- Working on the optimization of autonomous vehicles
in urban environments
...
```
Then, it produces one of these PDFs with its corresponding Typst file, Markdown file, HTML file, and images as PNGs. Click on the images below to preview PDF files.
| [](https://github.com/rendercv/rendercv/blob/main/examples/John_Doe_ClassicTheme_CV.pdf) | [](https://github.com/rendercv/rendercv/blob/main/examples/John_Doe_Sb2novTheme_CV.pdf) |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [](https://github.com/rendercv/rendercv/blob/main/examples/John_Doe_ModerncvTheme_CV.pdf) | [](https://github.com/rendercv/rendercv/blob/main/examples/John_Doe_EngineeringresumesTheme_CV.pdf) |
| [](https://github.com/rendercv/rendercv/blob/main/examples/John_Doe_EngineeringclassicTheme_CV.pdf) |  |
RenderCV comes with a JSON Schema so that the YAML input file can be filled out interactively.
## Getting Started
RenderCV engine is very easy to install (`pip install "rendercv[full]"`) and easy to use (`rendercv new "John Doe"`). Follow the [user guide](https://docs.rendercv.com/user_guide) to get started.
## Motivation
We are developing a [purpose-built app](https://rendercv.com) for writing CVs and resumes that will be available on mobile and web. This Python project is the foundation of that app. Check out [our blog post](https://rendercv.com/introducing-rendercv/) to learn more about why one would use such an app.
## Contributing
All contributions to RenderCV are welcome! To get started, please read [the developer guide](https://docs.rendercv.com/developer_guide).