35 Commits

Author SHA1 Message Date
Paul T
b8c30e2219 format: auto-formatting 2024-04-15 22:29:33 -04:00
Paul T
5b74cf40ee chore: increment versions in templates 2024-04-15 22:28:15 -04:00
Paul T
fad778ee86 Merge pull request #22 from DeveloperPaul123/feature/language-support
Add multi-langauge support
2024-04-15 13:05:34 -07:00
Paul T
f7a4ffdd17 docs: add docs on how to build and test template 2024-04-15 15:19:23 -04:00
Paul T
62286ddd14 chore: update images 2024-04-15 15:18:58 -04:00
Paul T
efd27110bd feat: add initial mult-lingaal support for template
Using linguify to support multiple languages
2024-04-15 13:07:43 -04:00
Paul T
033a0f7fbb chore: update thumbnails 2024-04-05 21:13:40 -04:00
Christoph Gross
bf1e3bd1f6 Ignore contact fields that are set to none (#16)
* Add optional contact info

Ignore contact fields that are set to none. 
Email is taken as the "priority" field which is most likely set and therefore doesn't have a separator field included. This could be either set to a different field or be replaced by a better function.

* Fix Expression error

---------

Co-authored-by: Paul T <developer.paul.123@gmail.com>
2024-04-05 21:10:12 -04:00
Paul T
201f6f7657 chore: update version to 0.3.0 2024-04-05 17:48:54 -07:00
Paul T
e477fc04df chore: add new line 2024-04-05 17:48:54 -07:00
Paul T
12ea6807a3 chore: update readme and screenshots 2024-04-05 17:48:54 -07:00
Paul T
6bd4116307 fix: update examples based on template changes 2024-04-05 17:48:54 -07:00
Paul T
d2482e1198 fix: minor issues with accent color, switch to kebab-case
Fixed minor issue with accent color and switch (fully) to using kebab case.

Fixes #17
Fixes #19
2024-04-05 17:48:54 -07:00
Paul T
9654d6ef7c build: ignore asset files when releasing package 2024-04-05 17:48:54 -07:00
Paul T
b23f46b9ba chore: shared repo config from fork 2024-04-05 17:48:54 -07:00
Paul T
bd9bfc1733 format: auto format update 2024-04-05 17:48:54 -07:00
Paul T
87e0609aa9 format: auto-formatting 2024-04-05 17:48:54 -07:00
Paul T
bf166be9fb feat: add script to format typst files 2024-04-05 17:48:54 -07:00
Paul T
0b7481e9be feature: add another coverletter example 2024-04-02 14:59:54 -07:00
Paul T
1709d6458d docs: add blurb in README about docs 2024-04-01 07:25:35 -07:00
Paul T
0d70af373b chore: update to checkout@v4 2024-04-01 07:25:35 -07:00
Paul T
5f91afd694 ci: fix output file name 2024-04-01 07:25:35 -07:00
Paul T
a0e579493a ci: fix package spelling 2024-04-01 07:25:35 -07:00
Paul T
15a6288165 ci: install needed fonts 2024-04-01 07:25:35 -07:00
Paul T
0dbf348b2b ci: set up initial script
Add CI to build documentation with each push
2024-04-01 07:25:35 -07:00
Paul T
311bf4fcc5 chore: minor README update 2024-04-01 06:26:47 -07:00
Paul T
c706d87704 feat(template): update resume and coverletter template
Updated template based on feedback from Lemmy and else where. Changes coloring scheme as well as some of the font/font weight and style used. Overall, this makes everything a lot more readable and easier to scan at a glance.
2024-04-01 06:26:47 -07:00
Paul T
803aea96cd chore: move image locations in repo 2024-04-01 06:26:47 -07:00
Paul T
48fc43779e build: add script to generate preview images 2024-04-01 06:26:47 -07:00
Paul T
d4ba30d3f2 chore: read version from toml when installing package locally
Updated script to read the package version from the toml file
2024-04-01 06:26:47 -07:00
Brandon Hu
6330bded37 fix(typos): replaced _ with - 2024-03-29 19:34:42 -07:00
Paul T
d73acd5dea chore: add funding.yml 2024-03-28 11:35:22 -04:00
Paul T
009adbe248 docs: update readme docs and reorganize images
Moved images to central folder and updated usage docs in the README
2024-03-28 08:31:48 -04:00
Paul T
bde0b7120c docs: update build/usage documentation
Resolves #2
2024-03-27 20:25:24 -04:00
Paul Tsouchlos
4f43e0b2b3 docs: fix formatting issue in README 2024-03-26 09:17:01 -07:00
22 changed files with 526 additions and 213 deletions

View File

@@ -0,0 +1,16 @@
[
{
"version" : 1
},
{
"action" : {
"script" : "${repo:path}/scripts/format_typst.ps1",
"showOutput" : true,
"type" : "sh",
"waitForExit" : true
},
"name" : "Format",
"os" : "windows",
"target" : "revision"
}
]

3
.github/FUNDING.yml vendored Normal file
View File

@@ -0,0 +1,3 @@
# Thanks for any donations! :)
github: DeveloperPaul123

View File

@@ -0,0 +1,21 @@
name: Build documentation
on: [push, workflow_dispatch]
jobs:
build_pdf:
runs-on: ubuntu-latest
steps:
- name: Set up Git repository
uses: actions/checkout@v4
- name: Install fonts
run: sudo apt-get install fonts-font-awesome fonts-roboto texlive-fonts-recommended texlive-fonts-extra
- name: Typst
uses: yusancky/setup-typst@v2
id: setup-typst
with:
version: 'v0.11.0'
- run: typst compile modern-cv-docs.typ
- name: Upload PDF file
uses: actions/upload-artifact@v3
with:
name: modern-cv-docs
path: modern-cv-docs.pdf

7
.issuetracker Normal file
View File

@@ -0,0 +1,7 @@
# Integration with Issue Tracker
#
# (note that '\' need to be escaped).
[issuetracker "Github"]
regex = "#(\\d+)"
url = "https://github.com/DeveloperPaul123/modern-cv/issues/$1"

View File

@@ -3,6 +3,7 @@
[![say thanks](https://img.shields.io/badge/Say%20Thanks-👍-1EAEDB.svg)](https://github.com/DeveloperPaul123/modern-cv/stargazers) [![say thanks](https://img.shields.io/badge/Say%20Thanks-👍-1EAEDB.svg)](https://github.com/DeveloperPaul123/modern-cv/stargazers)
[![Discord](https://img.shields.io/discord/652515194572111872?logo=Discord)](https://discord.gg/CX2ybByRnt) [![Discord](https://img.shields.io/discord/652515194572111872?logo=Discord)](https://discord.gg/CX2ybByRnt)
![Release](https://img.shields.io/github/v/release/DeveloperPaul123/modern-cv) ![Release](https://img.shields.io/github/v/release/DeveloperPaul123/modern-cv)
[![Build documentation](https://github.com/DeveloperPaul123/modern-cv/actions/workflows/build-documentation.yml/badge.svg)](https://github.com/DeveloperPaul123/modern-cv/actions/workflows/build-documentation.yml)
A port of the [Awesome-CV](https://github.com/posquit0/Awesome-CV) Latex resume template in [typst](https://github.com/typst/typst). A port of the [Awesome-CV](https://github.com/posquit0/Awesome-CV) Latex resume template in [typst](https://github.com/typst/typst).
@@ -13,7 +14,11 @@ You will need the `Roboto` and `Source Sans Pro` fonts installed on your system
- [Roboto](https://fonts.google.com/specimen/Roboto) - [Roboto](https://fonts.google.com/specimen/Roboto)
- [Source Sans Pro](https://github.com/adobe-fonts/source-sans-pro) - [Source Sans Pro](https://github.com/adobe-fonts/source-sans-pro)
This template also uses FontAwesome icons via the [`fontawesome`](https://typst.app/universe/package/fontawesome) package. This template also uses FontAwesome icons via the [fontawesome](https://typst.app/universe/package/fontawesome) package. You will need to install the fontawesome fonts on your system or configure the `typst` web app to use them. You can download fontawesome [here](https://fontawesome.com/download).
To use the fontawesome icons in the web app, add a `fonts` folder to your project and upload the `otf` files from the fontawesome download to this folder like so:
![alt text](assets/images/typst_web_editor.png)
See `typst fonts --help` for more information on configuring fonts for `typst` that are not installed on your system. See `typst fonts --help` for more information on configuring fonts for `typst` that are not installed on your system.
@@ -43,22 +48,58 @@ Below is a basic example for a simple resume:
= Education = Education
#resume_entry( #resume-entry(
title: "Example University", title: "Example University",
location: "B.S. in Computer Science", location: "B.S. in Computer Science",
date: "August 2014 - May 2019", date: "August 2014 - May 2019",
description: "Example" description: "Example"
) )
#resume_item[ #resume-item[
- #lorem(20) - #lorem(20)
- #lorem(15) - #lorem(15)
- #lorem(25) - #lorem(25)
] ]
``` ```
### Output After saving to a `*.typ` file, compile your resume using the following command:
| | | ```bash
typst compile resume.typ
```
For more information on how to use and compile `typst` files, see the [official documentation](https://typst.app/docs).
Documentation for this template is published with each commit. See the attached PDF on each Github Action run [here](https://github.com/DeveloperPaul123/modern-cv/actions).
### Output Examples
| Resumes | Cover letters |
| --- | --- | | --- | --- |
| ![Resume](resume.png) | ![Coverletter](coverletter.png) | | ![Resume](assets/images/resume.png) | ![Cover Letter](assets/images/coverletter.png) |
| ![Resume 2](assets/images/resume2.png) | ![Cover Letter 2](assets/images/coverletter2.png)|
## Building and Testing Locally
To build and test the project locally, you will need to install the `typst` CLI. You can find instructions on how to do this [here](https://typst.app/docs/getting-started).
With typst installed you can make changes to `lib.typ` and then `install_package_locally.ps1` to install the package locally. Change the import statements in the template files to point to the local package:
```typst
#import "@local/modern-cv:0.3.0": *
````
Note that the script parses the `typst.toml` to determine the version number and the folder the local files are installed to.
### Formatting
This project uses [typstyle](https://github.com/Enter-tainer/typstyle) to format the code. The script `format_typst.ps1` will format all the `*.typ` files in the project. Be sure to install `typstyle` before running the script.
## License
The project is licensed under the MIT license. See [LICENSE](LICENSE) for more details.
## Author
| [<img src="https://avatars0.githubusercontent.com/u/6591180?s=460&v=4" width="100"><br><sub>@DeveloperPaul123</sub>](https://github.com/DeveloperPaul123) |
|:----:|

Binary file not shown.

After

Width:  |  Height:  |  Size: 205 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 210 KiB

BIN
assets/images/resume.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 210 KiB

BIN
assets/images/resume2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 209 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 402 KiB

30
lang.toml Normal file
View File

@@ -0,0 +1,30 @@
[conf]
default-lang = "en"
[lang.en]
resume = "Résumé"
dear = "Dear"
cover-letter = "Cover Letter"
attached = "Attached"
curriculum-vitae = "Curriculum Vitae"
[lang.de]
resume = "Lebenslauf"
dear = "Sehr geehrte"
cover-letter = "Anschreiben"
attached = "Angehängt"
curriculum-vitae = "Lebenslauf"
[lang.gr]
resume = "Βιογραφικό"
dear = "Αγαπητέ"
cover-letter = "Συνοδευτική Επιστολή"
attached = "Συνημμένο"
curriculum-vitae = "Βιογραφικό"
[lang.sp]
resume = "Currículum"
dear = "Estimado"
cover-letter = "Carta de Presentación"
attached = "Adjunto"
curriculum-vitae = "Currículum"

403
lib.typ
View File

@@ -1,14 +1,19 @@
#import "@preview/fontawesome:0.1.0": * #import "@preview/fontawesome:0.1.0": *
#import "@preview/linguify:0.4.0": *
// const color // const color
#let color-darknight = rgb("131A28") #let color-darknight = rgb("#131A28")
#let color-darkgray = rgb("414141") #let color-darkgray = rgb("#333333")
#let color-gray = rgb("5d5d5d") #let color-gray = rgb("#5d5d5d")
#let default-accent-color = rgb("333ECC") #let default-accent-color = rgb("#262F99")
// const icons // const icons
#let linkedin-icon = box(fa-icon("linkedin", fa-set: "Brands", fill: color-darknight)) #let linkedin-icon = box(
#let github-icon = box(fa-icon("github", fa-set: "Brands", fill: color-darknight)) fa-icon("linkedin", fa-set: "Brands", fill: color-darknight),
)
#let github-icon = box(
fa-icon("github", fa-set: "Brands", fill: color-darknight),
)
// for some reason this icon doesn't work with fa-icon, so we use the local version // for some reason this icon doesn't work with fa-icon, so we use the local version
#let phone-icon = box(image("assets/icons/square-phone-solid.svg")) #let phone-icon = box(image("assets/icons/square-phone-solid.svg"))
#let email-icon = box(fa-icon("envelope", fill: color-darknight)) #let email-icon = box(fa-icon("envelope", fill: color-darknight))
@@ -50,28 +55,36 @@
/// Show a link with an icon, specifically for Github projects /// Show a link with an icon, specifically for Github projects
/// *Example* /// *Example*
/// #example(`resume.github-link("DeveloperPaul123/awesome-resume")`) /// #example(`resume.github-link("DeveloperPaul123/awesome-resume")`)
/// - github_path (string): The path to the Github project (e.g. "DeveloperPaul123/awesome-resume") /// - github-path (string): The path to the Github project (e.g. "DeveloperPaul123/awesome-resume")
/// -> none /// -> none
#let github-link(github_path) = { #let github-link(github-path) = {
set box(height: 11pt) set box(height: 11pt)
align(right + horizon)[ align(right + horizon)[
#fa-icon("github", fa-set: "Brands", fill: color-darkgray) #link("https://github.com/" + github_path, github_path) #fa-icon("github", fa-set: "Brands", fill: color-darkgray) #link(
"https://github.com/" + github-path,
github-path,
)
] ]
} }
/// Right section for the justified headers /// Right section for the justified headers
/// - body (content): The body of the right header /// - body (content): The body of the right header
/// - accent_color (color): The accent color to color the text with. This defaults to the default-accent-color #let secondary-right-header(body) = {
#let secondary-right-header(body, accent_color: default-accent-color) = { set text(
set text(accent_color, size: 11pt, style: "italic", weight: "light") size: 11pt,
weight: "medium",
)
body body
} }
/// Right section of a tertiaty headers. /// Right section of a tertiaty headers.
/// - body (content): The body of the right header /// - body (content): The body of the right header
#let tertiary-right-header(body) = { #let tertiary-right-header(body) = {
set text(weight: "light", style: "italic", size: 9pt) set text(
weight: "light",
size: 9pt,
)
body body
} }
@@ -79,7 +92,10 @@
/// - primary (content): The primary section of the header /// - primary (content): The primary section of the header
/// - secondary (content): The secondary section of the header /// - secondary (content): The secondary section of the header
#let justified-header(primary, secondary) = { #let justified-header(primary, secondary) = {
set block(above: 0.7em, below: 0.7em) set block(
above: 0.7em,
below: 0.7em,
)
pad[ pad[
#__justify_align[ #__justify_align[
== #primary == #primary
@@ -93,11 +109,11 @@
/// - primary (content): The primary section of the header /// - primary (content): The primary section of the header
/// - secondary (content): The secondary section of the header /// - secondary (content): The secondary section of the header
#let secondary-justified-header(primary, secondary) = { #let secondary-justified-header(primary, secondary) = {
__justify_align[ __justify_align[
=== #primary === #primary
][ ][
#tertiary-right-header[#secondary] #tertiary-right-header[#secondary]
] ]
} }
/// --- End of Helpers /// --- End of Helpers
@@ -109,32 +125,46 @@
/// ///
/// - author (content): Structure that takes in all the author's information /// - author (content): Structure that takes in all the author's information
/// - date (string): The date the resume was created /// - date (string): The date the resume was created
/// - accent_color (color): The accent color of the resume /// - accent-color (color): The accent color of the resume
/// - colored-headers (boolean): Whether the headers should be colored or not
/// - language (string): The language of the resume, defaults to "en". See lang.toml for available languages
/// - body (content): The body of the resume /// - body (content): The body of the resume
/// -> none /// -> none
#let resume( #let resume(
author: (:), author: (:),
date: datetime.today().display("[month repr:long] [day], [year]"), date: datetime.today().display("[month repr:long] [day], [year]"),
accent_color: default-accent-color, accent-color: default-accent-color,
body) = { colored-headers: true,
language: "en",
body,
) = {
if type(accent-color) == "string" {
accent-color = rgb(accent-color)
}
let lang_data = toml("lang.toml")
set document( set document(
author: author.firstname + " " + author.lastname, author: author.firstname + " " + author.lastname,
title: "resume", title: "resume",
) )
set text( set text(
font: ("Source Sans Pro"), font: ("Source Sans Pro"),
lang: "en", lang: language,
size: 11pt, size: 11pt,
fill: color-darkgray, fill: color-darkgray,
fallback: true fallback: true,
) )
set page( set page(
paper: "a4", paper: "a4",
margin: (left: 15mm, right: 15mm, top: 10mm, bottom: 10mm), margin: (left: 15mm, right: 15mm, top: 10mm, bottom: 10mm),
footer: [ footer: [
#set text(fill: gray, size: 8pt) #set text(
fill: gray,
size: 8pt,
)
#__justify_align_3[ #__justify_align_3[
#smallcaps[#date] #smallcaps[#date]
][ ][
@@ -142,7 +172,7 @@
#author.firstname #author.firstname
#author.lastname #author.lastname
#sym.dot.c #sym.dot.c
#"Résumé" #linguify("resume", from: lang_data)
] ]
][ ][
#counter(page).display() #counter(page).display()
@@ -152,34 +182,53 @@
) )
// set paragraph spacing // set paragraph spacing
show par: set block(above: 0.75em, below: 0.75em) show par: set block(
above: 0.75em,
below: 0.75em,
)
set par(justify: true) set par(justify: true)
set heading( set heading(
numbering: none, numbering: none,
outlined: false, outlined: false,
) )
show heading.where(level:1): it => [ show heading.where(level: 1): it => [
#set block(above: 1em, below: 1em) #set block(
above: 1em,
below: 1em,
)
#set text( #set text(
size: 16pt, size: 16pt,
weight: "regular" weight: "regular",
) )
#align(left)[ #align(left)[
#text[#strong[#text(accent_color)[#it.body.text.slice(0, 3)]]]#strong[#text[#it.body.text.slice(3)]] #let color = if colored-headers {
accent-color
} else {
color-darkgray
}
#text[#strong[#text(color)[#it.body.text]]]
#box(width: 1fr, line(length: 100%)) #box(width: 1fr, line(length: 100%))
] ]
] ]
show heading.where(level: 2): it => { show heading.where(level: 2): it => {
set text(color-darkgray, size: 12pt, style: "normal", weight: "bold") set text(
color-darkgray,
size: 12pt,
style: "normal",
weight: "bold",
)
it.body it.body
} }
show heading.where(level: 3): it => { show heading.where(level: 3): it => {
set text(size: 10pt, weight: "regular") set text(
size: 10pt,
weight: "regular",
)
smallcaps[#it.body] smallcaps[#it.body]
} }
@@ -187,67 +236,82 @@
align(center)[ align(center)[
#pad(bottom: 5pt)[ #pad(bottom: 5pt)[
#block[ #block[
#set text(size: 32pt, style: "normal", font: ("Roboto")) #set text(
#text(accent_color, weight: "thin")[#author.firstname] size: 32pt,
style: "normal",
font: ("Roboto"),
)
#text(fill: accent-color, weight: "thin")[#author.firstname]
#text(weight: "bold")[#author.lastname] #text(weight: "bold")[#author.lastname]
] ]
] ]
] ]
} }
let positions = { let positions = {
set text( set text(
accent_color, accent-color,
size: 9pt, size: 9pt,
weight: "regular" weight: "regular",
) )
align(center)[ align(center)[
#smallcaps[ #smallcaps[
#author.positions.join( #author.positions.join(
text[#" "#sym.dot.c#" "] text[#" "#sym.dot.c#" "],
) )
] ]
] ]
} }
let address = { let address = {
set text( set text(
size: 9pt, size: 9pt,
weight: "bold", weight: "bold",
style: "italic",
) )
align(center)[ align(center)[
#author.address #author.address
] ]
} }
let contacts = { let contacts = {
set box(height: 9pt) set box(height: 9pt)
let separator = box(width: 5pt) let separator = box(width: 5pt)
align(center)[ align(center)[
#set text(size: 9pt, weight: "regular", style: "normal") #set text(
size: 9pt,
weight: "regular",
style: "normal",
)
#block[ #block[
#align(horizon)[ #align(horizon)[
#phone-icon #if author.phone != none [
#box[#text(author.phone)] #phone-icon
#separator #box[#text(author.phone)]
#email-icon #separator
#box[#link("mailto:" + author.email)[#author.email]] ]
#separator #if author.email != none [
#github-icon #email-icon
#box[#link("https://github.com/" + author.github)[#author.github]] #box[#link("mailto:" + author.email)[#author.email]]
#separator ]
#linkedin-icon #if author.github != none [
#box[ #separator
#link("https://www.linkedin.com/in/" + author.linkedin)[#author.firstname #author.lastname] #github-icon
#box[#link("https://github.com/" + author.github)[#author.github]]
]
#if author.linkedin != none [
#separator
#linkedin-icon
#box[
#link("https://www.linkedin.com/in/" + author.linkedin)[#author.firstname #author.lastname]
]
] ]
] ]
] ]
] ]
} }
name name
positions positions
address address
@@ -259,7 +323,12 @@
/// This formats the item for the resume entries. Typically your body would be a bullet list of items. Could be your responsibilities at a company or your academic achievements in an educational background section. /// This formats the item for the resume entries. Typically your body would be a bullet list of items. Could be your responsibilities at a company or your academic achievements in an educational background section.
/// - body (content): The body of the resume entry /// - body (content): The body of the resume entry
#let resume-item(body) = { #let resume-item(body) = {
set text(size: 10pt, style: "normal", weight: "light") set text(
size: 10pt,
style: "normal",
weight: "light",
fill: color-darknight,
)
set par(leading: 0.65em) set par(leading: 0.65em)
body body
} }
@@ -270,10 +339,11 @@
/// - date (string): The date of the resume entry, this can be a range (e.g. "Jan 2020 - Dec 2020") /// - date (string): The date of the resume entry, this can be a range (e.g. "Jan 2020 - Dec 2020")
/// - description (content): The body of the resume entry /// - description (content): The body of the resume entry
#let resume-entry( #let resume-entry(
title: none, title: none,
location: "", location: "",
date: "", date: "",
description: "" description: "",
accent-color: default-accent-color,
) = { ) = {
pad[ pad[
#justified-header(title, location) #justified-header(title, location)
@@ -285,7 +355,11 @@
/// *Example:* /// *Example:*
/// #example(`resume.resume-gpa("3.5", "4.0")`) /// #example(`resume.resume-gpa("3.5", "4.0")`)
#let resume-gpa(numerator, denominator) = { #let resume-gpa(numerator, denominator) = {
set text(size: 12pt, style: "italic", weight: "light") set text(
size: 12pt,
style: "italic",
weight: "light",
)
text[Cumulative GPA: #box[#strong[#numerator] / #denominator]] text[Cumulative GPA: #box[#strong[#numerator] / #denominator]]
} }
@@ -314,7 +388,11 @@
== #category == #category
], ],
align(left)[ align(left)[
#set text(size: 11pt, style: "normal", weight: "light") #set text(
size: 11pt,
style: "normal",
weight: "light",
)
#items.join(", ") #items.join(", ")
], ],
) )
@@ -328,35 +406,46 @@
/// Cover letter template that is inspired by the Awesome CV Latex template by posquit0. This template can loosely be considered a port of the original Latex template. /// Cover letter template that is inspired by the Awesome CV Latex template by posquit0. This template can loosely be considered a port of the original Latex template.
/// This coverletter template is designed to be used with the resume template. /// This coverletter template is designed to be used with the resume template.
/// - author (content): Structure that takes in all the author's information /// - author (content): Structure that takes in all the author's information
/// - profile_picture (image): The profile picture of the author. This will be cropped to a circle and should be square in nature. /// - profile-picture (image): The profile picture of the author. This will be cropped to a circle and should be square in nature.
/// - date (date): The date the cover letter was created /// - date (date): The date the cover letter was created
/// - accent_color (color): The accent color of the cover letter /// - accent-color (color): The accent color of the cover letter
/// - body (content): The body of the cover letter /// - body (content): The body of the cover letter
#let coverletter( #let coverletter(
author: (:), author: (:),
profile_picture: image, profile-picture: image,
date: datetime.today().display("[month repr:long] [day], [year]"), date: datetime.today().display("[month repr:long] [day], [year]"),
accent_color: default-accent-color, accent-color: default-accent-color,
body language: "en",
body,
) = { ) = {
if type(accent-color) == "string" {
accent-color = rgb(accent-color)
}
// language data
let lang_data = toml("lang.toml")
set document( set document(
author: author.firstname + " " + author.lastname, author: author.firstname + " " + author.lastname,
title: "resume", title: "cover-letter",
) )
set text( set text(
font: ("Source Sans Pro"), font: ("Source Sans Pro"),
lang: "en", lang: language,
size: 11pt, size: 11pt,
fill: color-darkgray, fill: color-darkgray,
fallback: true fallback: true,
) )
set page( set page(
paper: "a4", paper: "a4",
margin: (left: 15mm, right: 15mm, top: 10mm, bottom: 10mm), margin: (left: 15mm, right: 15mm, top: 10mm, bottom: 10mm),
footer: [ footer: [
#set text(fill: gray, size: 8pt) #set text(
fill: gray,
size: 8pt,
)
#__justify_align_3[ #__justify_align_3[
#smallcaps[#date] #smallcaps[#date]
][ ][
@@ -364,7 +453,7 @@
#author.firstname #author.firstname
#author.lastname #author.lastname
#sym.dot.c #sym.dot.c
#"Cover Letter" #linguify("cover-letter", from: lang_data)
] ]
][ ][
#counter(page).display() #counter(page).display()
@@ -374,23 +463,29 @@
) )
// set paragraph spacing // set paragraph spacing
show par: set block(above: 0.75em, below: 0.75em) show par: set block(
above: 0.75em,
below: 0.75em,
)
set par(justify: true) set par(justify: true)
set heading( set heading(
numbering: none, numbering: none,
outlined: false, outlined: false,
) )
show heading: it => [ show heading: it => [
#set block(above: 1em, below: 1em) #set block(
above: 1em,
below: 1em,
)
#set text( #set text(
size: 16pt, size: 16pt,
weight: "regular" weight: "regular",
) )
#align(left)[ #align(left)[
#text[#strong[#text(accent_color)[#it.body.text.slice(0, 3)]]]#strong[#text[#it.body.text.slice(3)]] #text[#strong[#text(accent-color)[#it.body.text]]]
#box(width: 1fr, line(length: 100%)) #box(width: 1fr, line(length: 100%))
] ]
] ]
@@ -399,136 +494,168 @@
align(right)[ align(right)[
#pad(bottom: 5pt)[ #pad(bottom: 5pt)[
#block[ #block[
#set text(size: 32pt, style: "normal", font: ("Roboto")) #set text(
#text(accent_color, weight: "thin")[#author.firstname] size: 32pt,
style: "normal",
font: ("Roboto"),
)
#text(accent-color, weight: "thin")[#author.firstname]
#text(weight: "bold")[#author.lastname] #text(weight: "bold")[#author.lastname]
] ]
] ]
] ]
} }
let positions = { let positions = {
set text( set text(
accent_color, accent-color,
size: 9pt, size: 9pt,
weight: "regular" weight: "regular",
) )
align(right)[ align(right)[
#smallcaps[ #smallcaps[
#author.positions.join( #author.positions.join(
text[#" "#sym.dot.c#" "] text[#" "#sym.dot.c#" "],
) )
] ]
] ]
} }
let address = { let address = {
set text( set text(
size: 9pt, size: 9pt,
weight: "regular", weight: "bold",
style: "italic", fill: color-gray,
fill: color-gray
) )
align(right)[ align(right)[
#author.address #author.address
] ]
} }
let contacts = { let contacts = {
set box(height: 9pt) set box(height: 9pt)
let separator = [#box(sym.bar.v)] let separator = [#box(sym.bar.v)]
align(right)[ align(right)[
#set text(size: 8pt, weight: "light", style: "normal") #set text(
size: 8pt,
weight: "light",
style: "normal",
)
#block[ #block[
#align(horizon)[ #align(horizon)[
#stack(dir: ltr, spacing: 0.5em, #stack(
phone-icon, dir: ltr,
box[#text(author.phone)], spacing: 0.5em,
separator, if author.phone != none [
email-icon, #phone-icon
box[#link("mailto:" + author.email)[#author.email]], #box[#text(author.phone)]
separator, #separator
github-icon, ],
box[#link("https://github.com/" + author.github)[#author.github]], if author.email != none [
separator, #email-icon
linkedin-icon, #box[#link("mailto:" + author.email)[#author.email]]
box[ ],
if author.github != none [
#separator
#github-icon
#box[#link("https://github.com/" + author.github)[#author.github]]
],
if author.linkedin != none [
#separator
#linkedin-icon
#box[
#link("https://www.linkedin.com/in/" + author.linkedin)[#author.firstname #author.lastname] #link("https://www.linkedin.com/in/" + author.linkedin)[#author.firstname #author.lastname]
] ]
],
) )
] ]
] ]
] ]
} }
let letter-heading = { let letter-heading = {
grid(columns: (1fr, 2fr), grid(
columns: (1fr, 2fr),
rows: (100pt), rows: (100pt),
align(left+horizon)[ align(left + horizon)[
#block(clip: true, stroke: 0pt, radius: 2cm, #block(
width: 4cm, height: 4cm, profile_picture) clip: true,
stroke: 0pt,
radius: 2cm,
width: 4cm,
height: 4cm,
profile-picture,
)
], ],
[ [
#name #name
#positions #positions
#address #address
#contacts #contacts
] ],
) )
} }
let letter_conclusion = { let letter-conclusion = {
align(bottom)[ align(bottom)[
#pad(bottom: 2em)[ #pad(bottom: 2em)[
#text(weight: "light")[Sincerely,] \ #text(weight: "light")[Sincerely,] \
#text(weight: "bold")[#author.firstname #author.lastname] \ \ #text(weight: "bold")[#author.firstname #author.lastname] \ \
#text(weight: "light", style: "italic")[Attached: Curriculum Vitae] #text(weight: "light", style: "italic")[ #linguify(
"attached",
from: lang_data,
)#sym.colon #linguify("curriculum-vitae", from: lang_data)]
] ]
] ]
} }
// actual content // actual content
letter-heading letter-heading
body body
linebreak() linebreak()
letter_conclusion letter-conclusion
} }
/// Cover letter heading that takes in the information for the hiring company and formats it properly. /// Cover letter heading that takes in the information for the hiring company and formats it properly.
/// - entity_info (content): The information of the hiring entity including the company name, the target (who's attention to), street address, and city /// - entity-info (content): The information of the hiring entity including the company name, the target (who's attention to), street address, and city
/// - date (date): The date the letter was written (defaults to the current date) /// - date (date): The date the letter was written (defaults to the current date)
#let hiring-entity-info(entity_info: (:), date: datetime.today().display("[month repr:long] [day], [year]")) = { #let hiring-entity-info(
entity-info: (:),
date: datetime.today().display("[month repr:long] [day], [year]"),
) = {
set par(leading: 1em) set par(leading: 1em)
pad(top: 1.5em, bottom: 1.5em)[ pad(top: 1.5em, bottom: 1.5em)[
#__justify_align[ #__justify_align[
#text(weight: "bold", size: 12pt)[#entity_info.target] #text(weight: "bold", size: 12pt)[#entity-info.target]
][ ][
#text(weight: "light", style: "italic", size: 9pt)[#date] #text(weight: "light", style: "italic", size: 9pt)[#date]
] ]
#pad(top: 0.65em, bottom: 0.65em)[ #pad(top: 0.65em, bottom: 0.65em)[
#text(weight: "regular", fill: color-gray, size: 9pt)[ #text(weight: "regular", fill: color-gray, size: 9pt)[
#smallcaps[#entity_info.name] \ #smallcaps[#entity-info.name] \
#entity_info.street_address \ #entity-info.street-address \
#entity_info.city \ #entity-info.city \
] ]
] ]
] ]
} }
/// Letter heading for a given job position and addressee. /// Letter heading for a given job position and addressee.
/// - job_position (string): The job position you are applying for /// - job-position (string): The job position you are applying for
/// - addressee (string): The person you are addressing the letter to /// - addressee (string): The person you are addressing the letter to
#let letter-heading(job_position: "", addressee: "") = { #let letter-heading(job-position: "", addressee: "") = {
let lang_data = toml("lang.toml")
// TODO: Make this adaptable to content // TODO: Make this adaptable to content
underline(evade: false, stroke: 0.5pt, offset: 0.3em)[ underline(evade: false, stroke: 0.5pt, offset: 0.3em)[
#text(weight: "bold", size: 12pt)[Job Application for #job_position] #text(weight: "bold", size: 12pt)[Job Application for #job-position]
] ]
pad(top: 1em, bottom: 1em)[ pad(top: 1em, bottom: 1em)[
#text(weight: "light", fill: color-gray)[ #text(weight: "light", fill: color-gray)[
Dear #addressee, #linguify("dear", from: lang_data) #addressee,
] ]
] ]
} }

View File

@@ -2,8 +2,8 @@
#import "@preview/tidy:0.2.0" #import "@preview/tidy:0.2.0"
#let docs = tidy.parse-module( #let docs = tidy.parse-module(
read("lib.typ"), read("lib.typ"),
name: "Modern CV", name: "Modern CV",
scope: (resume: lib) scope: (resume: lib),
) )
#tidy.show-module(docs) #tidy.show-module(docs)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 420 KiB

5
scripts/format_typst.ps1 Normal file
View File

@@ -0,0 +1,5 @@
# requires typstyle to be installed
# cargo install typstyle
# get all *.typ files and format them
Get-ChildItem -Path $PSScriptRoot/../*.typ -Recurse | ForEach-Object { typstyle -i $_.FullName }

View File

@@ -1,3 +1,10 @@
# requires the PSToml cmdlet to be installed
# https://github.com/jborean93/PSToml?tab=readme-ov-file
# Install-Module -Name PSToml -Scope AllUsers
$typst_toml = ConvertFrom-Toml (Get-Content "$PSScriptRoot/../typst.toml" -Raw)
Write-Host 'Package version: ' $typst_toml.package.version
$Source = "$PSScriptRoot/../*" $Source = "$PSScriptRoot/../*"
$Destination = "$env:LOCALAPPDATA/typst/packages/local/modern-cv/0.1.0" $Destination = "$env:LOCALAPPDATA/typst/packages/local/modern-cv/$($typst_toml.package.version)"
New-Item -ItemType Directory -Path $Destination -Force
Copy-Item -Path $Source -Destination $Destination -Recurse -Force Copy-Item -Path $Source -Destination $Destination -Recurse -Force

View File

@@ -0,0 +1,5 @@
typst compile -f png $PSScriptRoot/../template/resume.typ $PSScriptRoot/../assets/images/resume.png
typst compile -f png $PSScriptRoot/../template/coverletter.typ $PSScriptRoot/../assets/images/coverletter.png
typst compile -f png $PSScriptRoot/../template/coverletter2.typ $PSScriptRoot/../assets/images/coverletter2.png
oxipng.exe $PSScriptRoot/../assets/images/*

View File

@@ -1,39 +1,38 @@
#import "@preview/modern-cv:0.1.0":* #import "@preview/modern-cv:0.3.0": *
#show: coverletter.with( #show: coverletter.with(
author: ( author: (
firstname: "John", firstname: "John",
lastname: "Smith", lastname: "Smith",
email: "js@gmail.com", email: "js@gmail.com",
phone: "(+1) 111-111-1111", phone: "(+1) 111-111-1111",
github: "DeveloperPaul123", github: "DeveloperPaul123",
linkedin: "John Smith", linkedin: "John Smith",
address: "111 Example St. Apt. 111, Example City, EX 11111", address: "111 Example St. Apt. 111, Example City, EX 11111",
positions: ( positions: (
"Software Engineer", "Software Engineer",
"Full Stack Developer" "Full Stack Developer",
) ),
), ),
profile_picture: image("./profile.png") profile-picture: image("./profile.png"),
language: "en",
) )
#hiring-entity-info( #hiring-entity-info(entity-info: (
entity_info: ( target: "Company Recruitement Team",
target: "Company Recruitement Team", name: "Google, Inc.",
name: "Google, Inc.", street-address: "1600 AMPHITHEATRE PARKWAY",
street_address: "1600 AMPHITHEATRE PARKWAY", city: "MOUNTAIN VIEW, CA 94043",
city: "MOUNTAIN VIEW, CA 94043" ))
)
)
#letter-heading( #letter-heading(
job_position: "Software Engineer", job-position: "Software Engineer",
addressee: "Sir or Madame" addressee: "Sir or Madame",
) )
= About Me = About Me
#coverletter-content[ #coverletter-content[
#lorem(80) #lorem(80)
] ]
= Why Google? = Why Google?

43
template/coverletter2.typ Normal file
View File

@@ -0,0 +1,43 @@
#import "@preview/modern-cv:0.3.0": *
#show: coverletter.with(
author: (
firstname: "John",
lastname: "Smith",
email: "js@gmail.com",
phone: "(+1) 111-111-1111",
github: "DeveloperPaul123",
linkedin: "John Smith",
address: "111 Example St. Apt. 111, Example City, EX 11111",
positions: (
"Software Engineer",
"Full Stack Developer",
),
),
profile-picture: none,
language: "en",
)
#hiring-entity-info(entity-info: (
target: "Company Recruitement Team",
name: "Google, Inc.",
street-address: "1600 AMPHITHEATRE PARKWAY",
city: "MOUNTAIN VIEW, CA 94043",
))
#letter-heading(
job-position: "Software Engineer",
addressee: "Sir or Madame",
)
#coverletter-content[
#lorem(100)
]
#coverletter-content[
#lorem(90)
]
#coverletter-content[
#lorem(110)
]

View File

@@ -1,63 +1,51 @@
#import "@preview/modern-cv:0.1.0": * #import "@preview/modern-cv:0.3.0": *
#show: resume.with( #show: resume.with(
author: ( author: (
firstname: "John", firstname: "John",
lastname: "Smith", lastname: "Smith",
email: "js@example.com", email: "js@example.com",
phone: "(+1) 111-111-1111", phone: "(+1) 111-111-1111",
github: "DeveloperPaul123", github: "DeveloperPaul123",
linkedin: "Example", linkedin: "Example",
address: "111 Example St. Example City, EX 11111", address: "111 Example St. Example City, EX 11111",
positions: ( positions: (
"Software Engineer", "Software Engineer",
"Software Architect" "Software Architect",
) "Developer",
),
), ),
date: datetime.today().display() date: datetime.today().display(),
language: "en",
colored-headers: true,
) )
= Education
#resume-entry(
title: "Example University",
location: "B.S. in Computer Science",
date: "August 2014 - May 2019",
description: "Example"
)
#resume-item[
- #lorem(20)
- #lorem(15)
- #lorem(25)
]
= Experience = Experience
#resume-entry( #resume-entry(
title: "Example, Inc.", title: "Senior Software Engineer",
location: "Example City, EX", location: "Example City, EX",
date: "2019 - Present", date: "2019 - Present",
description: "Senior Software Engineer" description: "Example, Inc.",
) )
#resume-item[ #resume-item[
- #lorem(20) - #lorem(20)
- #lorem(15) - #lorem(15)
- #lorem(25) - #lorem(25)
] ]
#resume-entry( #resume-entry(
title: "Previous Company, Inc.", title: "Software Engineer",
location: "Example City, EX", location: "Example City, EX",
date: "2011 - 2019", date: "2011 - 2019",
description: "Software Engineer" description: "Previous Company, Inc.",
) )
#resume-item[ #resume-item[
- #lorem(20) - #lorem(20)
- #lorem(15) - #lorem(15)
- #lorem(25) - #lorem(25)
] ]
= Projects = Projects
@@ -66,7 +54,7 @@
title: "Thread Pool C++ Library", title: "Thread Pool C++ Library",
location: [#github-link("DeveloperPaul123/thread-pool")], location: [#github-link("DeveloperPaul123/thread-pool")],
date: "May 2021 - Present", date: "May 2021 - Present",
description: "Designer/Developer" description: "Designer/Developer",
) )
#resume-item[ #resume-item[
@@ -75,10 +63,10 @@
] ]
#resume-entry( #resume-entry(
title: " Event Bus C++ Library", title: "Event Bus C++ Library",
location: github-link("DeveloperPaul123/eventbus"), location: github-link("DeveloperPaul123/eventbus"),
date: "Sep. 2019 - Present", date: "Sep. 2019 - Present",
description: "Designer/Developer" description: "Designer/Developer",
) )
#resume-item[ #resume-item[
@@ -88,6 +76,27 @@
= Skills = Skills
#resume-skill-item("Programming Languages", (strong("C++"), "Python", "Java", "C#", "JavaScript", "TypeScript")) #resume-skill-item(
"Languages",
(strong("C++"), strong("Python"), "Java", "C#", "JavaScript", "TypeScript"),
)
#resume-skill-item("Spoken Languages", (strong("English"), "Spanish")) #resume-skill-item("Spoken Languages", (strong("English"), "Spanish"))
#resume-skill-item("Programs", (strong("Excel"),"Word")) #resume-skill-item(
"Programs",
(strong("Excel"), "Word", "Powerpoint", "Visual Studio"),
)
= Education
#resume-entry(
title: "Example University",
location: "Example City, EX",
date: "August 2014 - May 2019",
description: "B.S. in Computer Science",
)
#resume-item[
- #lorem(20)
- #lorem(15)
- #lorem(25)
]

View File

@@ -1,6 +1,6 @@
[package] [package]
name = "modern-cv" name = "modern-cv"
version = "0.1.0" version = "0.3.0"
compiler = "0.11.0" compiler = "0.11.0"
entrypoint = "lib.typ" entrypoint = "lib.typ"
authors = ["Paul Tsouchlos <https://github.com/DeveloperPaul123>"] authors = ["Paul Tsouchlos <https://github.com/DeveloperPaul123>"]
@@ -9,11 +9,11 @@ description = "A modern resume template based on the Awesome-CV Latex template."
keywords = ["CV", "Curriculum Vitae", "Resume", "Minimalistic", "Professional", "Modern"] keywords = ["CV", "Curriculum Vitae", "Resume", "Minimalistic", "Professional", "Modern"]
categories = ["cv"] categories = ["cv"]
disciplines = [] disciplines = []
exclude = ["resume-documentation*", "scripts*"] exclude = ["resume-documentation*", "scripts*", "assets/images/*"]
homepage = "https://github.com/DeveloperPaul123/modern-cv" homepage = "https://github.com/DeveloperPaul123/modern-cv"
repository = "https://github.com/DeveloperPaul123/modern-cv" repository = "https://github.com/DeveloperPaul123/modern-cv"
[template] [template]
path = "template" path = "template"
entrypoint = "resume.typ" entrypoint = "resume.typ"
thumbnail = "resume.png" thumbnail = "assets/images/resume.png"