|
| 1 | +# Neat CV |
| 2 | +[](https://github.com/dialvarezs/neat-cv/releases) |
| 3 | +[](https://github.com/dialvarezs/neat-cv/actions/workflows/ci.yml) |
| 4 | + |
| 5 | +[](https://github.com/dialvarezs/neat-cv/stargazers) |
| 6 | + |
| 7 | +A modern and elegant CV template for Typst, inspired by [Awesome CV](https://github.com/posquit0/Awesome-CV) and [simple-hipstercv](https://github.com/latex-ninja/simple-hipstercv). |
| 8 | + |
| 9 | +## Features |
| 10 | + |
| 11 | +- Modern, clean two-column layout with sidebar |
| 12 | +- Cover letter template |
| 13 | +- Customizable accent color and fonts |
| 14 | +- Publication list generated from Hayagriva YAML, grouped by year, with author highlighting |
| 15 | +- Level bars for languages and skills |
| 16 | +- Social/contact info with icons and clickable links |
| 17 | + |
| 18 | +## Preview |
| 19 | + |
| 20 | +### CV |
| 21 | + |
| 22 | +<img src="assets/cv_p1.png" alt="CV Page 1" width="49%"/> <img src="assets/cv_p2.png" alt="CV Page 2" width="49%"/> |
| 23 | + |
| 24 | +### Cover Letter |
| 25 | + |
| 26 | +<img src="assets/letter.png" alt="Cover letter" width="49%"/> |
| 27 | + |
| 28 | +## Requirements |
| 29 | + |
| 30 | +### Software |
| 31 | + |
| 32 | +- [typst](https://typst.app/) (tested with v0.13.0+) |
| 33 | + |
| 34 | +### Fonts |
| 35 | + |
| 36 | +#### Text Fonts |
| 37 | + |
| 38 | +By default, this template uses the Fira Sans and Noto Sans fonts. Roboto is used as a fallback font if Noto Sans is not available. |
| 39 | + |
| 40 | +If you use the template through the webapp (https://typst.app), you don't need to do anything. |
| 41 | + |
| 42 | +If you want to use it locally instead, you will need to install these fonts on your system to use the template with its defaults. You have a few options for this: |
| 43 | +- Use [fontist](https://github.com/fontist/fontist) to install the fonts automatically: |
| 44 | + ```bash |
| 45 | + fontist manifest-install manifest.yml |
| 46 | + fontist fontconfig update |
| 47 | + ``` |
| 48 | +- Download the fonts manually and install them in your system's font directory: |
| 49 | + - [Fira Sans](https://fonts.google.com/specimen/Fira+Sans) |
| 50 | + - [Noto Sans](https://fonts.google.com/specimen/Noto+Sans) |
| 51 | +- (Linux) Install them via your package manager, as most distributions provide these fonts in their repositories. |
| 52 | + |
| 53 | +#### Icon Fonts |
| 54 | + |
| 55 | +This template uses FontAwesome icons via the [fontawesome](https://typst.app/universe/package/fontawesome) package. |
| 56 | +To install the icons, you need to download the "FontAwesome Free For Desktop" package from the [FontAwesome website](https://fontawesome.com/download) and install the `.otf` files in your system's font directory. |
| 57 | + |
| 58 | +If you are using the webapp (https://typst.app/), upload the entire `otf/` directory to your project and the fonts will be recognized automatically (possibly after a reload). |
| 59 | + |
| 60 | +## Usage |
| 61 | + |
| 62 | +### CV |
| 63 | + |
| 64 | +Here is a basic usage example: |
| 65 | + |
| 66 | +```typst |
| 67 | +#import "@preview/neat-cv:0.6.0": cv, side, entry, item-with-level, contact-info, social-links |
| 68 | +
|
| 69 | +#show: cv.with( |
| 70 | + author: ( |
| 71 | + firstname: "John", |
| 72 | + lastname: "Smith", |
| 73 | + |
| 74 | + position: ("Data Scientist"), |
| 75 | + github: "jsmith", |
| 76 | + ), |
| 77 | + profile-picture: image("my_profile.png"), |
| 78 | +) |
| 79 | +
|
| 80 | +#side[ |
| 81 | + = About Me |
| 82 | + Just someone learning Typst. |
| 83 | +
|
| 84 | + = Contact |
| 85 | + #contact-info() |
| 86 | +
|
| 87 | + = Skills |
| 88 | + #item-with-level("Python", 4) |
| 89 | + #item-with-level("Bash", 3) |
| 90 | +
|
| 91 | + #v(1fr) |
| 92 | + #social-links() |
| 93 | +] |
| 94 | +
|
| 95 | += Education |
| 96 | +
|
| 97 | +#entry( |
| 98 | + title: "Master of Science in Data Science", |
| 99 | + institution: "University of Somewhere", |
| 100 | + location: "Somewhere, World", |
| 101 | + date: "2023", |
| 102 | + [Thesis: "My thesis title"], |
| 103 | +) |
| 104 | +
|
| 105 | += Experience |
| 106 | +
|
| 107 | +#entry( |
| 108 | + title: "Data Scientist", |
| 109 | + institution: "Somewhere Inc.", |
| 110 | + location: "Somewhere, World", |
| 111 | + date: "2023 - Present", |
| 112 | + [ |
| 113 | + - Worked on some interesting projects. |
| 114 | + ], |
| 115 | +) |
| 116 | +``` |
| 117 | + |
| 118 | +For a more complete example, see the `template/cv.typ` file in the repository. |
| 119 | + |
| 120 | +### Cover Letter |
| 121 | + |
| 122 | +You can also create a matching cover letter: |
| 123 | + |
| 124 | +```typst |
| 125 | +#import "@preview/neat-cv:0.6.0": letter |
| 126 | +
|
| 127 | +#show: letter.with( |
| 128 | + author: ( |
| 129 | + firstname: "John", |
| 130 | + lastname: "Smith", |
| 131 | + |
| 132 | + address: [123 Main St\ City, Country], |
| 133 | + phone: "(555) 123-4567", |
| 134 | + position: ("Data Scientist"), |
| 135 | + ), |
| 136 | + profile-picture: image("my_profile.png"), |
| 137 | + accent-color: rgb("#4682b4"), |
| 138 | + recipient: [ |
| 139 | + Jane Doe\ |
| 140 | + Hiring Manager\ |
| 141 | + Company Inc.\ 456 Business Ave\ City, Country |
| 142 | + ], |
| 143 | +) |
| 144 | +
|
| 145 | +Dear Ms. Doe, |
| 146 | +
|
| 147 | +I am writing to express my interest in the Data Scientist position at Company Inc. |
| 148 | +
|
| 149 | +// Your letter content here... |
| 150 | +
|
| 151 | +Sincerely, |
| 152 | +
|
| 153 | +#align(right)[John Smith] |
| 154 | +``` |
| 155 | + |
| 156 | +For a complete example, see the `template/letter.typ` file in the repository. |
0 commit comments