Skip to content

Latest commit

 

History

History
94 lines (68 loc) · 4.15 KB

README.md

File metadata and controls

94 lines (68 loc) · 4.15 KB
Raw



AwesomeCV-Typst

Check Status Badge Typst Demo


AwesomeCV-Typst is a Typst template for making Résume, CV or Cover Letter inspired by the famous LaTeX CV template Awesome-CV. It provides customizations and multilingual support beyond the original LaTeX project.

Preview

CV Cover Letter
CV Cover Letter
CV (French, red, no photo) Cover Letter (French, red)
CV Cover Letter

Usage

Project Structure

|
|-- modules/          --> sections of your CV, include these at cv.typ
|   |- *.typ
|
|-- modules_*         --> multilingual sections of your CV
|
|-- awesomeCV/
|   |- template.typ   --> the template file, imported in the documents
|   |- metadata-demo.typ -> the example metadata file that contains all variables used in the template
| 
|
|-- src/
|   |- fonts/         --> local font files
|   |- logos/         --> logos for your cvEntry
|   |- *.png          --> images used in the documents
|   |- *.bib          --> BibTeX file for Publications section
|
|-- cv.typ          --> CV file
|-- letter.typ      --> Cover Letter file
|-- metadata.typ    --> your Personal Info variables & language settings

Tips

  • Build your own personal metadata.typ file on the root folder, by copying the awesomeCV/metadata-demo.typ file
  • Host your submodules in different languages in respective subfoler (./modules_fr for instance)

Installation

You can either directly create a new repository by using this template, or you might want to add the submodule repository and build up your own Typst project.

Method 1: Jumpstart by clicking Use this template and create your own CV repository

When compiling, use: typst compile ./cv.typ ./output/CV.pdf --font-path ./src/fonts/

Method 2: Add the submodule repository to your existing project

cd your/CV/project
git submodule add https://github.com/mintyfrankie/awesomeCV-Typst-Submodule awesomeCV
typst compile cv.typ

When you want to get new features from the updated template module:

git submodule update --remote

Current Issues

As Typst is still a very young (although very promising and robust to my belief) project, some features are only partially supported on certain platforms. It is hence difficult to predict any anomalies, but you are definitely welcomed to bring a PR, an issue or a discussion!

  • Image cropping: Typst does not have direct support to crop images using native primitives. Bring your own cropped image for profile photo if needed.
  • Publications Section: Current version of Typst does not allow full customization on the #bibliography function, so the display of publication section might not be optimal. See this disucssion.

Credit

  • Typst is a newborn, open source and simple typesetting engine that offers a better scripting experience than LaTeX.
  • Awesome-CV is the original LaTeX CV template from which this project is heavily inspired. Thanks posquit0 for your excellent work!