1 Commits

Author SHA1 Message Date
Paul Tsouchlos
b0293dc61a docs: fix formatting issue in README 2024-03-26 12:13:39 -04:00
14 changed files with 47 additions and 100 deletions

3
.github/FUNDING.yml vendored
View File

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

View File

@@ -1,21 +0,0 @@
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

View File

@@ -3,7 +3,6 @@
[![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)
![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).
@@ -14,11 +13,7 @@ You will need the `Roboto` and `Source Sans Pro` fonts installed on your system
- [Roboto](https://fonts.google.com/specimen/Roboto)
- [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. 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)
This template also uses FontAwesome icons via the [`fontawesome`](https://typst.app/universe/package/fontawesome) package.
See `typst fonts --help` for more information on configuring fonts for `typst` that are not installed on your system.
@@ -48,32 +43,22 @@ Below is a basic example for a simple resume:
= Education
#resume-entry(
#resume_entry(
title: "Example University",
location: "B.S. in Computer Science",
date: "August 2014 - May 2019",
description: "Example"
)
#resume-item[
#resume_item[
- #lorem(20)
- #lorem(15)
- #lorem(25)
]
```
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
| | |
| --- | --- |
| ![Resume](assets/images/resume.png) | ![Cover Letter](assets/images/coverletter.png) |
| ![Resume](resume.png) | ![Coverletter](coverletter.png) |

Binary file not shown.

Before

Width:  |  Height:  |  Size: 205 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 210 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 26 KiB

BIN
coverletter.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 402 KiB

29
lib.typ
View File

@@ -1,10 +1,10 @@
#import "@preview/fontawesome:0.1.0": *
// const color
#let color-darknight = rgb("#131A28")
#let color-darkgray = rgb("#333333")
#let color-gray = rgb("#5d5d5d")
#let default-accent-color = rgb("#262F99")
#let color-darknight = rgb("131A28")
#let color-darkgray = rgb("414141")
#let color-gray = rgb("5d5d5d")
#let default-accent-color = rgb("333ECC")
// const icons
#let linkedin-icon = box(fa-icon("linkedin", fa-set: "Brands", fill: color-darknight))
@@ -64,14 +64,14 @@
/// - 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, accent_color: default-accent-color) = {
set text(size: 11pt, weight: "medium")
set text(accent_color, size: 11pt, style: "italic", weight: "light")
body
}
/// Right section of a tertiaty headers.
/// - body (content): The body of the right header
#let tertiary-right-header(body) = {
set text(weight: "light", size: 9pt)
set text(weight: "light", style: "italic", size: 9pt)
body
}
@@ -110,14 +110,12 @@
/// - author (content): Structure that takes in all the author's information
/// - date (string): The date the resume was created
/// - accent_color (color): The accent color of the resume
/// - colored_headers (boolean): Whether the headers should be colored or not
/// - body (content): The body of the resume
/// -> none
#let resume(
author: (:),
date: datetime.today().display("[month repr:long] [day], [year]"),
accent_color: default-accent-color,
colored_headers : true,
body) = {
set document(
author: author.firstname + " " + author.lastname,
@@ -169,9 +167,8 @@
weight: "regular"
)
#align(left)[
#let color = if colored_headers { accent_color } else { color-darkgray }
#text[#strong[#text(color)[#it.body.text]]]
#align(left)[
#text[#strong[#text(accent_color)[#it.body.text.slice(0, 3)]]]#strong[#text[#it.body.text.slice(3)]]
#box(width: 1fr, line(length: 100%))
]
]
@@ -216,7 +213,8 @@
let address = {
set text(
size: 9pt,
weight: "bold"
weight: "bold",
style: "italic",
)
align(center)[
#author.address
@@ -261,7 +259,7 @@
/// 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
#let resume-item(body) = {
set text(size: 10pt, style: "normal", weight: "light", fill: color-darknight)
set text(size: 10pt, style: "normal", weight: "light")
set par(leading: 0.65em)
body
}
@@ -392,7 +390,7 @@
)
#align(left)[
#text[#strong[#text(accent_color)[#it.body.text]]]
#text[#strong[#text(accent_color)[#it.body.text.slice(0, 3)]]]#strong[#text[#it.body.text.slice(3)]]
#box(width: 1fr, line(length: 100%))
]
]
@@ -427,7 +425,8 @@
let address = {
set text(
size: 9pt,
weight: "bold",
weight: "regular",
style: "italic",
fill: color-gray
)
align(right)[

BIN
resume.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 420 KiB

View File

@@ -1,10 +1,3 @@
# 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/../*"
$Destination = "$env:LOCALAPPDATA/typst/packages/local/modern-cv/$($typst_toml.package.version)"
New-Item -ItemType Directory -Path $Destination -Force
$Destination = "$env:LOCALAPPDATA/typst/packages/local/modern-cv/0.1.0"
Copy-Item -Path $Source -Destination $Destination -Recurse -Force

View File

@@ -1,4 +0,0 @@
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
oxipng.exe $PSScriptRoot/../assets/images/*

View File

@@ -1,4 +1,4 @@
#import "@preview/modern-cv:0.2.0":*
#import "@preview/modern-cv:0.1.0":*
#show: coverletter.with(
author: (

View File

@@ -1,4 +1,4 @@
#import "@preview/modern-cv:0.2.0": *
#import "@preview/modern-cv:0.1.0": *
#show: resume.with(
author: (
@@ -11,21 +11,34 @@
address: "111 Example St. Example City, EX 11111",
positions: (
"Software Engineer",
"Software Architect",
"Developer"
"Software Architect"
)
),
date: datetime.today().display(),
colored_headers: true
date: datetime.today().display()
)
= 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
#resume-entry(
title: "Senior Software Engineer",
title: "Example, Inc.",
location: "Example City, EX",
date: "2019 - Present",
description: "Example, Inc."
description: "Senior Software Engineer"
)
#resume-item[
@@ -35,10 +48,10 @@
]
#resume-entry(
title: "Software Engineer",
title: "Previous Company, Inc.",
location: "Example City, EX",
date: "2011 - 2019",
description: "Previous Company, Inc."
description: "Software Engineer"
)
#resume-item[
@@ -62,7 +75,7 @@
]
#resume-entry(
title: "Event Bus C++ Library",
title: " Event Bus C++ Library",
location: github-link("DeveloperPaul123/eventbus"),
date: "Sep. 2019 - Present",
description: "Designer/Developer"
@@ -75,21 +88,6 @@
= Skills
#resume-skill-item("Languages", (strong("C++"), strong("Python"), "Java", "C#", "JavaScript", "TypeScript"))
#resume-skill-item("Programming Languages", (strong("C++"), "Python", "Java", "C#", "JavaScript", "TypeScript"))
#resume-skill-item("Spoken Languages", (strong("English"), "Spanish"))
#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)
]
#resume-skill-item("Programs", (strong("Excel"),"Word"))

View File

@@ -1,6 +1,6 @@
[package]
name = "modern-cv"
version = "0.2.0"
version = "0.1.0"
compiler = "0.11.0"
entrypoint = "lib.typ"
authors = ["Paul Tsouchlos <https://github.com/DeveloperPaul123>"]
@@ -16,4 +16,4 @@ repository = "https://github.com/DeveloperPaul123/modern-cv"
[template]
path = "template"
entrypoint = "resume.typ"
thumbnail = "assets/images/resume.png"
thumbnail = "resume.png"