docs: add blurb in README about docs

Add CI to build documentation with each push

.github/FUNDING.yml

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

.github/workflows/build-documentation.yml

@@ -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

README.md

@@ -3,6 +3,7 @@
 [![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).
 
@@ -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)
 - [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.
 
@@ -43,22 +48,32 @@ 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](resume.png) | ![Coverletter](coverletter.png) |
+| ![Resume](assets/images/resume.png) | ![Cover Letter](assets/images/coverletter.png) |

lib.typ

@@ -1,10 +1,10 @@
 #import "@preview/fontawesome:0.1.0": *
 
 // 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
 #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(accent_color, size: 11pt, style: "italic", weight: "light")
+  set text(size: 11pt, weight: "medium")
   body
 }
 
 /// Right section of a tertiaty headers. 
 /// - body (content): The body of the right header
 #let tertiary-right-header(body) = {
-  set text(weight: "light", style: "italic", size: 9pt)
+  set text(weight: "light", size: 9pt)
   body
 }
 
@@ -110,12 +110,14 @@
 /// - 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, 
@@ -168,7 +170,8 @@
     )
     
     #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%))
     ]
   ]
@@ -213,8 +216,7 @@
   let address = {
     set text(
       size: 9pt,
-      weight: "bold",
+      weight: "bold"
-      style: "italic",
     )
     align(center)[
       #author.address
@@ -259,7 +261,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")
+  set text(size: 10pt, style: "normal", weight: "light", fill: color-darknight)
   set par(leading: 0.65em)
   body
 }
@@ -390,7 +392,7 @@
     )
     
     #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%))
     ]
   ]
@@ -425,8 +427,7 @@
   let address = {
     set text(
       size: 9pt,
-      weight: "regular",
+      weight: "bold",
-      style: "italic",
       fill: color-gray
     )
     align(right)[

scripts/install_package_locally.ps1

@@ -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/../*"
-$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

scripts/update_thumbnails.ps1

@@ -0,0 +1,4 @@
+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/*

template/coverletter.typ

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

template/resume.typ

@@ -1,4 +1,4 @@
-#import "@preview/modern-cv:0.1.0": *
+#import "@preview/modern-cv:0.2.0": *
 
 #show: resume.with(
   author: (
@@ -11,34 +11,21 @@
       address: "111 Example St. Example City, EX 11111",
       positions: (
         "Software Engineer",
-        "Software Architect"
+        "Software Architect",
+        "Developer"
       )
   ),
-  date: datetime.today().display()
+  date: datetime.today().display(),
+  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
 
 #resume-entry(
-  title: "Example, Inc.",
+  title: "Senior Software Engineer",
   location: "Example City, EX",
   date: "2019 - Present",
-  description: "Senior Software Engineer"
+  description: "Example, Inc."
 )
 
 #resume-item[
@@ -48,10 +35,10 @@
 ]
 
 #resume-entry(
-  title: "Previous Company, Inc.",
+  title: "Software Engineer",
   location: "Example City, EX",
   date: "2011 - 2019",
-  description: "Software Engineer"
+  description: "Previous Company, Inc."
 )
 
 #resume-item[
@@ -88,6 +75,21 @@
 
 = 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("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)  
+]

typst.toml

@@ -1,6 +1,6 @@
 [package]
 name = "modern-cv"
-version = "0.1.0"
+version = "0.2.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 = "resume.png"
+thumbnail = "assets/images/resume.png"