chore: update version used in templates

feat: add ability to show/hide footer

.fork/custom-commands.json

@@ -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"
+  }
+]

.github/FUNDING.yml

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

.github/workflows/build-documentation.yml

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

.issuetracker

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

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.
 
@@ -22,7 +27,7 @@ See `typst fonts --help` for more information on configuring fonts for `typst` t
 Below is a basic example for a simple resume:
 
 ```typst
-#import "@preview/modern-cv:0.1.0": *
+#import "@preview/modern-cv:0.5.0": *
 
 #show: resume.with(
   author: (
@@ -43,22 +48,58 @@ 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)  
 ]
 ```
 
-### 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) |
+|:----:|

assets/icons/LICENSE.txt

@@ -1,165 +0,0 @@
-Fonticons, Inc. (https://fontawesome.com)
-
---------------------------------------------------------------------------------
-
-Font Awesome Free License
-
-Font Awesome Free is free, open source, and GPL friendly. You can use it for
-commercial projects, open source projects, or really almost whatever you want.
-Full Font Awesome Free license: https://fontawesome.com/license/free.
-
---------------------------------------------------------------------------------
-
-# Icons: CC BY 4.0 License (https://creativecommons.org/licenses/by/4.0/)
-
-The Font Awesome Free download is licensed under a Creative Commons
-Attribution 4.0 International License and applies to all icons packaged
-as SVG and JS file types.
-
---------------------------------------------------------------------------------
-
-# Fonts: SIL OFL 1.1 License
-
-In the Font Awesome Free download, the SIL OFL license applies to all icons
-packaged as web and desktop font files.
-
-Copyright (c) 2023 Fonticons, Inc. (https://fontawesome.com)
-with Reserved Font Name: "Font Awesome".
-
-This Font Software is licensed under the SIL Open Font License, Version 1.1.
-This license is copied below, and is also available with a FAQ at:
-http://scripts.sil.org/OFL
-
-SIL OPEN FONT LICENSE
-Version 1.1 - 26 February 2007
-
-PREAMBLE
-The goals of the Open Font License (OFL) are to stimulate worldwide
-development of collaborative font projects, to support the font creation
-efforts of academic and linguistic communities, and to provide a free and
-open framework in which fonts may be shared and improved in partnership
-with others.
-
-The OFL allows the licensed fonts to be used, studied, modified and
-redistributed freely as long as they are not sold by themselves. The
-fonts, including any derivative works, can be bundled, embedded,
-redistributed and/or sold with any software provided that any reserved
-names are not used by derivative works. The fonts and derivatives,
-however, cannot be released under any other type of license. The
-requirement for fonts to remain under this license does not apply
-to any document created using the fonts or their derivatives.
-
-DEFINITIONS
-"Font Software" refers to the set of files released by the Copyright
-Holder(s) under this license and clearly marked as such. This may
-include source files, build scripts and documentation.
-
-"Reserved Font Name" refers to any names specified as such after the
-copyright statement(s).
-
-"Original Version" refers to the collection of Font Software components as
-distributed by the Copyright Holder(s).
-
-"Modified Version" refers to any derivative made by adding to, deleting,
-or substituting — in part or in whole — any of the components of the
-Original Version, by changing formats or by porting the Font Software to a
-new environment.
-
-"Author" refers to any designer, engineer, programmer, technical
-writer or other person who contributed to the Font Software.
-
-PERMISSION & CONDITIONS
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of the Font Software, to use, study, copy, merge, embed, modify,
-redistribute, and sell modified and unmodified copies of the Font
-Software, subject to the following conditions:
-
-1) Neither the Font Software nor any of its individual components,
-in Original or Modified Versions, may be sold by itself.
-
-2) Original or Modified Versions of the Font Software may be bundled,
-redistributed and/or sold with any software, provided that each copy
-contains the above copyright notice and this license. These can be
-included either as stand-alone text files, human-readable headers or
-in the appropriate machine-readable metadata fields within text or
-binary files as long as those fields can be easily viewed by the user.
-
-3) No Modified Version of the Font Software may use the Reserved Font
-Name(s) unless explicit written permission is granted by the corresponding
-Copyright Holder. This restriction only applies to the primary font name as
-presented to the users.
-
-4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
-Software shall not be used to promote, endorse or advertise any
-Modified Version, except to acknowledge the contribution(s) of the
-Copyright Holder(s) and the Author(s) or with their explicit written
-permission.
-
-5) The Font Software, modified or unmodified, in part or in whole,
-must be distributed entirely under this license, and must not be
-distributed under any other license. The requirement for fonts to
-remain under this license does not apply to any document created
-using the Font Software.
-
-TERMINATION
-This license becomes null and void if any of the above conditions are
-not met.
-
-DISCLAIMER
-THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
-OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
-COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
-DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
-OTHER DEALINGS IN THE FONT SOFTWARE.
-
---------------------------------------------------------------------------------
-
-# Code: MIT License (https://opensource.org/licenses/MIT)
-
-In the Font Awesome Free download, the MIT license applies to all non-font and
-non-icon files.
-
-Copyright 2023 Fonticons, Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in the
-Software without restriction, including without limitation the rights to use, copy,
-modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
-and to permit persons to whom the Software is furnished to do so, subject to the
-following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
-INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
-PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
---------------------------------------------------------------------------------
-
-# Attribution
-
-Attribution is required by MIT, SIL OFL, and CC BY licenses. Downloaded Font
-Awesome Free files already contain embedded comments with sufficient
-attribution, so you shouldn't need to do anything additional when using these
-files normally.
-
-We've kept attribution comments terse, so we ask that you do not actively work
-to remove them from files, especially code. They're a great way for folks to
-learn about Font Awesome.
-
---------------------------------------------------------------------------------
-
-# Brand Icons
-
-All brand icons are trademarks of their respective owners. The use of these
-trademarks does not indicate endorsement of the trademark holder by Font
-Awesome, nor vice versa. **Please do not use brand logos for any purpose except
-to represent the company, product, or service to which they refer.**

assets/icons/square-phone-solid.svg

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Pro 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license (Commercial License) Copyright 2023 Fonticons, Inc. --><path d="M64 32C28.7 32 0 60.7 0 96V416c0 35.3 28.7 64 64 64H384c35.3 0 64-28.7 64-64V96c0-35.3-28.7-64-64-64H64zm90.7 96.7c9.7-2.6 19.9 2.3 23.7 11.6l20 48c3.4 8.2 1 17.6-5.8 23.2L168 231.7c16.6 35.2 45.1 63.7 80.3 80.3l20.2-24.7c5.6-6.8 15-9.2 23.2-5.8l48 20c9.3 3.9 14.2 14 11.6 23.7l-12 44C336.9 378 329 384 320 384C196.3 384 96 283.7 96 160c0-9 6-16.9 14.7-19.3l44-12z"/></svg>

lang.toml

@@ -0,0 +1,66 @@
+[conf]
+default-lang = "en"
+
+[lang.en]
+resume = "Résumé"
+dear = "Dear"
+cover-letter = "Cover Letter"
+attached = "Attached"
+curriculum-vitae = "Curriculum Vitae"
+sincerely = "Sincerely"
+
+[lang.de]
+resume = "Lebenslauf"
+dear = "Sehr geehrte"
+cover-letter = "Anschreiben"
+attached = "Angehängt"
+curriculum-vitae = "Lebenslauf"
+sincerely = "Aufrichtig"
+
+[lang.gr]
+resume = "Βιογραφικό"
+dear = "Αγαπητέ"
+cover-letter = "Συνοδευτική Επιστολή"
+attached = "Συνημμένο"
+curriculum-vitae = "Βιογραφικό"
+sincerely = "Με εκτίμηση"
+
+[lang.pt]
+resume = "Currículo"
+dear = "Caro(a)"
+cover-letter = "Carta de Apresentação"
+attached = "Em anexo"
+curriculum-vitae = "Currículo"
+sincerely = "Atenciosamente"
+
+[lang.sp]
+resume = "Currículum"
+dear = "Estimado"
+cover-letter = "Carta de Presentación"
+attached = "Adjunto"
+curriculum-vitae = "Currículum"
+sincerely = "Sinceramente"
+
+[lang.fr]
+resume = "Curriculum Vitae"
+dear = "Cher/Chère"
+cover-letter = "Lettre de motivation"
+attached = "Ci-joint"
+curriculum-vitae = "Curriculum Vitae"
+sincerely = "Sincèrement"
+
+[lang.ru]
+resume = "Резюме"
+dear = "Уважаемый"
+cover-letter = "Сопроводительное письмо"
+attached = "Прилагается"
+curriculum-vitae = "Биографическая справка"
+sincerely = "Искренне"
+
+[lang.zh]
+resume = "简历"
+dear = "亲爱的"
+cover-letter = "求职信"
+attached = "附件"
+curriculum-vitae = "简历"
+sincerely = "真诚的"

lib.typ

@@ -1,17 +1,33 @@
-#import "@preview/fontawesome:0.1.0": *
+#import "@preview/fontawesome:0.2.1": *
+#import "@preview/linguify:0.4.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")
+#let default-location-color = rgb("#333333")
 
 // 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", fill: color-darknight),
-// 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 github-icon = box(
+  fa-icon("github", fill: color-darknight),
+)
+#let twitter-icon = box(
+  fa-icon("twitter", fill: color-darknight),
+)
+#let google-scholar-icon = box(
+  fa-icon("google-scholar", fill: color-darknight),
+)
+#let orcid-icon = box(
+  fa-icon("orcid", fill: color-darknight),
+)
+#let phone-icon = box(fa-icon("square-phone", fill: color-darknight))
 #let email-icon = box(fa-icon("envelope", fill: color-darknight))
+#let birth-icon = box(fa-icon("cake", fill: color-darknight))
+#let homepage-icon = box(fa-icon("home", fill: color-darknight))
 
 /// Helpers
 
@@ -47,31 +63,83 @@
   ]
 }
 
+#let __coverletter_footer(author, language, date, lang_data) = {
+  set text(
+    fill: gray,
+    size: 8pt,
+  )
+  __justify_align_3[
+    #smallcaps[#date]
+  ][
+    #smallcaps[
+      #if language == "zh" or language == "ja" [
+        #author.firstname#author.lastname
+      ] else [
+        #author.firstname#sym.space#author.lastname
+      ]
+      #sym.dot.c
+      #linguify("cover-letter", from: lang_data)
+    ]
+  ][
+    #counter(page).display()
+  ]
+}
+
+#let __resume_footer(author, language, lang_data, date) = {
+  set text(
+    fill: gray,
+    size: 8pt,
+  )
+  __justify_align_3[
+    #smallcaps[#date]
+  ][
+    #smallcaps[
+      #if language == "zh" or language == "ja" [
+        #author.firstname#author.lastname
+      ] else [
+        #author.firstname#sym.space#author.lastname
+      ]
+      #sym.dot.c
+      #linguify("resume", from: lang_data)
+    ]
+  ][
+    #counter(page).display()
+  ]
+}
+
 /// Show a link with an icon, specifically for Github projects
 /// *Example*
 /// #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
-#let github-link(github_path) = {
+#let github-link(github-path) = {
   set box(height: 11pt)
   
   align(right + horizon)[
-    #fa-icon("github", fa-set: "Brands", fill: color-darkgray) #link("https://github.com/" + github_path, github_path)
+    #fa-icon("github", fill: color-darkgray) #link(
+      "https://github.com/" + github-path,
+      github-path,
+    )
   ]
 }
 
 /// Right section for the justified headers
 /// - 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
 }
 
 /// 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
 }
 
@@ -79,7 +147,10 @@
 /// - primary (content): The primary section of the header
 /// - secondary (content): The secondary section of the header
 #let justified-header(primary, secondary) = {
-  set block(above: 0.7em, below: 0.7em)
+  set block(
+    above: 0.7em,
+    below: 0.7em,
+  )
   pad[
     #__justify_align[
       == #primary
@@ -109,50 +180,52 @@
 ///
 /// - 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
+/// - 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
 /// -> none
 #let resume(
   author: (:),
   date: datetime.today().display("[month repr:long] [day], [year]"),
-  accent_color: default-accent-color, 
+  accent-color: default-accent-color,
-  body) = {
+  colored-headers: true,
+  show-footer: true,
+  language: "en",
+  font: ("Source Sans Pro", "Source Sans 3"),
+  body,
+) = {
+  if type(accent-color) == "string" {
+    accent-color = rgb(accent-color)
+  }
+  
+  let lang_data = toml("lang.toml")
+  
   set document(
     author: author.firstname + " " + author.lastname,
     title: "resume",
   )
   
   set text(
-    font: ("Source Sans Pro"),
+    font: font,
-    lang: "en",
+    lang: language,
     size: 11pt,
     fill: color-darkgray,
-    fallback: true
+    fallback: true,
   )
   
   set page(
     paper: "a4",
     margin: (left: 15mm, right: 15mm, top: 10mm, bottom: 10mm),
-    footer: [
+    footer: if show-footer [#__resume_footer(author, language, lang_data, date)] else [],
-      #set text(fill: gray, size: 8pt)
-      #__justify_align_3[
-        #smallcaps[#date]
-      ][
-        #smallcaps[
-          #author.firstname
-          #author.lastname
-          #sym.dot.c
-          #"Résumé"
-        ]
-      ][
-        #counter(page).display()
-      ]
-    ],
     footer-descent: 0pt,
   )
   
   // 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 heading(
@@ -161,25 +234,43 @@
   )
   
   show heading.where(level: 1): it => [
-    #set block(above: 1em, below: 1em)
+    
+    #set block(
+      above: 1em,
+      below: 1em,
+    )
     #set text(
       size: 16pt,
-      weight: "regular"
+      weight: "regular",
     )
     
     #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%))
     ]
+    
   ]
   
   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
   }
   
   show heading.where(level: 3): it => {
-    set text(size: 10pt, weight: "regular")
+    set text(
+      size: 10pt,
+      weight: "regular",
+    )
     smallcaps[#it.body]
   }
   
@@ -187,24 +278,35 @@
     align(center)[
       #pad(bottom: 5pt)[
         #block[
-          #set text(size: 32pt, style: "normal", font: ("Roboto"))
+          #set text(
-          #text(accent_color, weight: "thin")[#author.firstname]
+            size: 32pt,
+            style: "normal",
+            font: ("Roboto"),
+          )
+          #if language == "zh" or language == "ja" [
+            #text(
+              accent-color,
+              weight: "thin",
+            )[#author.firstname]#text(weight: "bold")[#author.lastname]
+          ] else [
+            #text(accent-color, weight: "thin")[#author.firstname]
             #text(weight: "bold")[#author.lastname]
           ]
         ]
       ]
+    ]
   }
   
   let positions = {
     set text(
-      accent_color,
+      accent-color,
       size: 9pt,
-      weight: "regular"
+      weight: "regular",
     )
     align(center)[
       #smallcaps[
         #author.positions.join(
-          text[#"  "#sym.dot.c#"  "]
+          text[#"  "#sym.dot.c#"  "],
         )
       ]
     ]
@@ -213,12 +315,13 @@
   let address = {
     set text(
       size: 9pt,
-      weight: "bold",
+      weight: "regular",
-      style: "italic",
     )
     align(center)[
+      #if ("address" in author) [
         #author.address
       ]
+    ]
   }
   
   let contacts = {
@@ -227,21 +330,59 @@
     let separator = box(width: 5pt)
     
     align(center)[
-      #set text(size: 9pt, weight: "regular", style: "normal")
+      #set text(
+        size: 9pt,
+        weight: "regular",
+        style: "normal",
+      )
       #block[
         #align(horizon)[
+          #if ("birth" in author) [
+            #birth-icon
+            #box[#text(author.birth)]
+            #separator
+          ]
+          #if ("phone" in author) [
             #phone-icon
             #box[#text(author.phone)]
             #separator
+          ]
+          #if ("email" in author) [
             #email-icon
             #box[#link("mailto:" + author.email)[#author.email]]
+          ]
+          #if ("homepage" in author) [
+            #separator
+            #homepage-icon
+            #box[#link(author.homepage)[#author.homepage]]
+          ]
+          #if ("github" in author) [
             #separator
             #github-icon
             #box[#link("https://github.com/" + author.github)[#author.github]]
+          ]
+          #if ("linkedin" in author) [
             #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.linkedin]
+            ]
+          ]
+          #if ("twitter" in author) [
+            #separator
+            #twitter-icon
+            #box[#link("https://twitter.com/" + author.twitter)[\@#author.twitter]]
+          ]
+          #if ("scholar" in author) [
+            #let fullname = str(author.firstname + " " + author.lastname)
+            #separator
+            #google-scholar-icon
+            #box[#link("https://scholar.google.com/citations?user=" + author.scholar)[#fullname]]
+          ]
+          #if ("orcid" in author) [
+            #separator
+            #orcid-icon
+            #box[#link("https://orcid.org/" + author.orcid)[#author.orcid]]
           ]
         ]
       ]
@@ -259,7 +400,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.
 /// - 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
 }
@@ -269,23 +415,42 @@
 /// - location (string): The location of the resume entry
 /// - 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
+/// - title-link (string): The link to use for the title (can be none)
+/// - accent-color (color): Override the accent color of the resume-entry
+/// - location-color (color): Override the default color of the "location" for a resume entry.
 #let resume-entry(
   title: none,
   location: "",
   date: "",
-  description: ""
+  description: "",
+  title-link: none,
+  accent-color: default-accent-color,
+  location-color: default-location-color,
 ) = {
+  let title-content
+  if type(title-link) == "string" {
+    title-content = link(title-link)[#title]
+  } else {
+    title-content = title
+  }
+  
   pad[
-    #justified-header(title, location)
+    #justified-header(title-content, location)
+    #if description != "" or date != "" [
       #secondary-justified-header(description, date)
     ]
+  ]
 }
 
 /// Show cumulative GPA.
 /// *Example:*
 /// #example(`resume.resume-gpa("3.5", "4.0")`)
 #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]]
 }
 
@@ -314,7 +479,11 @@
         == #category
       ],
       align(left)[
-        #set text(size: 11pt, style: "normal", weight: "light")
+        #set text(
+          size: 11pt,
+          style: "normal",
+          weight: "light",
+        )
         #items.join(", ")
       ],
     )
@@ -328,53 +497,52 @@
 /// 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.
 /// - 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
-/// - 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
 #let coverletter(
   author: (:),
-  profile_picture: image,
+  profile-picture: image,
   date: datetime.today().display("[month repr:long] [day], [year]"),
-  accent_color: default-accent-color,
+  accent-color: default-accent-color,
-  body
+  language: "en",
+  font: ("Source Sans Pro", "Source Sans 3"),
+  show-footer: true,
+  body,
 ) = {
+  if type(accent-color) == "string" {
+    accent-color = rgb(accent-color)
+  }
+  
+  // language data
+  let lang_data = toml("lang.toml")
+  
   set document(
     author: author.firstname + " " + author.lastname,
-    title: "resume",
+    title: "cover-letter",
   )
   
   set text(
-    font: ("Source Sans Pro"),
+    font: font,
-    lang: "en",
+    lang: language,
     size: 11pt,
     fill: color-darkgray,
-    fallback: true
+    fallback: true,
   )
   
   set page(
     paper: "a4",
     margin: (left: 15mm, right: 15mm, top: 10mm, bottom: 10mm),
-    footer: [
+    footer: if show-footer [#__coverletter_footer(author, language, date, lang_data)] else [],
-      #set text(fill: gray, size: 8pt)
-      #__justify_align_3[
-        #smallcaps[#date]
-      ][
-        #smallcaps[
-          #author.firstname
-          #author.lastname
-          #sym.dot.c
-          #"Cover Letter"
-        ]
-      ][
-        #counter(page).display()
-      ]
-    ],
     footer-descent: 0pt,
   )
   
   // 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 heading(
@@ -383,14 +551,17 @@
   )
   
   show heading: it => [
-    #set block(above: 1em, below: 1em)
+    #set block(
+      above: 1em,
+      below: 1em,
+    )
     #set text(
       size: 16pt,
-      weight: "regular"
+      weight: "regular",
     )
     
     #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%))
     ]
   ]
@@ -399,24 +570,36 @@
     align(right)[
       #pad(bottom: 5pt)[
         #block[
-          #set text(size: 32pt, style: "normal", font: ("Roboto"))
+          #set text(
-          #text(accent_color, weight: "thin")[#author.firstname]
+            size: 32pt,
+            style: "normal",
+            font: ("Roboto"),
+          )
+          #if language == "zh" or language == "ja" [
+            #text(
+              accent-color,
+              weight: "thin",
+            )[#author.firstname]#text(weight: "bold")[#author.lastname]
+          ] else [
+            #text(accent-color, weight: "thin")[#author.firstname]
             #text(weight: "bold")[#author.lastname]
           ]
+          
+        ]
       ]
     ]
   }
   
   let positions = {
     set text(
-      accent_color,
+      accent-color,
       size: 9pt,
-      weight: "regular"
+      weight: "regular",
     )
     align(right)[
       #smallcaps[
         #author.positions.join(
-          text[#"  "#sym.dot.c#"  "]
+          text[#"  "#sym.dot.c#"  "],
         )
       ]
     ]
@@ -425,13 +608,14 @@
   let address = {
     set text(
       size: 9pt,
-      weight: "regular",
+      weight: "bold",
-      style: "italic",
+      fill: color-gray,
-      fill: color-gray
     )
     align(right)[
+      #if ("address" in author) [
         #author.address
       ]
+    ]
   }
   
   let contacts = {
@@ -440,23 +624,37 @@
     let separator = [#box(sym.bar.v)]
     
     align(right)[
-      #set text(size: 8pt, weight: "light", style: "normal")
+      #set text(
+        size: 8pt,
+        weight: "light",
+        style: "normal",
+      )
       #block[
         #align(horizon)[
-          #stack(dir: ltr, spacing: 0.5em,
+          #stack(
-              phone-icon,
+            dir: ltr,
-              box[#text(author.phone)],
+            spacing: 0.5em,
-              separator,
+            if ("phone" in author) [
-              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 ("email" in author) [
-              separator,
+              #email-icon
-              linkedin-icon,
+              #box[#link("mailto:" + author.email)[#author.email]]
-              box[
+            ],
+            if ("github" in author) [
+              #separator
+              #github-icon
+              #box[#link("https://github.com/" + author.github)[#author.github]]
+            ],
+            if ("linkedin" in author) [
+              #separator
+              #linkedin-icon
+              #box[
                 #link("https://www.linkedin.com/in/" + author.linkedin)[#author.firstname #author.lastname]
               ]
+            ],
           )
         ]
       ]
@@ -464,27 +662,40 @@
   }
   
   let letter-heading = {
-    grid(columns: (1fr, 2fr), 
+    grid(
+      columns: (1fr, 2fr),
       rows: (100pt),
       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
         #positions
         #address
         #contacts
-      ]
+      ],
     )
   }
   
-  let letter_conclusion = {
+  let letter-conclusion = {
     align(bottom)[
       #pad(bottom: 2em)[
-        #text(weight: "light")[Sincerely,] \
+        #text(weight: "light")[#linguify(
+            "sincerely",
+            from: lang_data,
+          )#sym.comma] \
         #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)]
       ]
     ]
   }
@@ -493,42 +704,53 @@
   letter-heading
   body
   linebreak()
-  letter_conclusion
+  letter-conclusion
 }
 
 /// 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)
-#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)
   pad(top: 1.5em, bottom: 1.5em)[
     #__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]
     ]
     
     #pad(top: 0.65em, bottom: 0.65em)[
       #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.
-/// - 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
-#let letter-heading(job_position: "", addressee: "") = {
+/// - dear (string): optional field for redefining the "dear" variable
+#let letter-heading(job-position: "", addressee: "", dear: "") = {
+  let lang_data = toml("lang.toml")
+  
   // TODO: Make this adaptable to content
   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)[
     #text(weight: "light", fill: color-gray)[
-      Dear #addressee,
+      #if dear == "" [
+        #linguify("dear", from: lang_data)
+      ] else [
+        #dear
+      ]
+      #addressee,
     ]
   ]
 }

modern-cv-docs.typ

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

scripts/format_typst.ps1

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

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,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/*

template/coverletter.typ

@@ -1,34 +1,36 @@
-#import "@preview/modern-cv:0.1.0":*
+#import "@preview/modern-cv:0.6.0": *
 
 #show: coverletter.with(
   author: (
     firstname: "John",
     lastname: "Smith",
     email: "js@gmail.com",
+    homepage: "https://example.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"
+      "Full Stack Developer",
-      )
     ),
-  profile_picture: image("./profile.png")
+  ),
+  profile-picture: image("./profile.png"),
+  language: "en",
+  font: "Times New Roman",
+  // show-footer: false, // Uncomment to hide footer
 )
 
-#hiring-entity-info(
+#hiring-entity-info(entity-info: (
-    entity_info: (
   target: "Company Recruitement Team",
   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(
-  job_position: "Software Engineer",
+  job-position: "Software Engineer",
-  addressee: "Sir or Madame"
+  addressee: "Sir or Madame",
 )
 
 = About Me

template/coverletter2.typ

@@ -0,0 +1,44 @@
+#import "@preview/modern-cv:0.6.0": *
+
+#show: coverletter.with(
+  author: (
+    firstname: "John",
+    lastname: "Smith",
+    email: "js@gmail.com",
+    homepage: "https://example.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: "sp",
+)
+
+#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)
+]

template/resume.typ

@@ -1,44 +1,39 @@
-#import "@preview/modern-cv:0.1.0": *
+#import "@preview/modern-cv:0.6.0": *
 
 #show: resume.with(
   author: (
     firstname: "John",
     lastname: "Smith",
     email: "js@example.com",
+    homepage: "https://example.com",
     phone: "(+1) 111-111-1111",
     github: "DeveloperPaul123",
+    twitter: "typstapp",
+    scholar: "",
+    orcid: "0000-0000-0000-000X",
+    birth: "January 1, 1990",
     linkedin: "Example",
     address: "111 Example St. Example City, EX 11111",
     positions: (
       "Software Engineer",
-        "Software Architect"
+      "Software Architect",
-      )
+      "Developer",
     ),
-  date: datetime.today().display()
+  ),
+  date: datetime.today().display(),
+  language: "en",
+  colored-headers: true,
+  show-footer: false,
 )
 
-= 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.",
+  title-link: "https://github.com/DeveloperPaul123",
 )
 
 #resume-item[
@@ -48,10 +43,21 @@
 ]
 
 #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[
+  - #lorem(20)
+  - #lorem(15)
+  - #lorem(25)
+]
+
+#resume-entry(
+  title: "Intern",
+  location: "Example City, EX",
 )
 
 #resume-item[
@@ -66,7 +72,7 @@
   title: "Thread Pool C++ Library",
   location: [#github-link("DeveloperPaul123/thread-pool")],
   date: "May 2021 - Present",
-  description: "Designer/Developer"
+  description: "Designer/Developer",
 )
 
 #resume-item[
@@ -78,7 +84,7 @@
   title: "Event Bus C++ Library",
   location: github-link("DeveloperPaul123/eventbus"),
   date: "Sep. 2019 - Present",
-  description: "Designer/Developer"
+  description: "Designer/Developer",
 )
 
 #resume-item[
@@ -88,6 +94,27 @@
 
 = 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.6.0"
 compiler = "0.11.0"
 entrypoint = "lib.typ"
 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"]
 categories = ["cv"]
 disciplines = []
-exclude = ["resume-documentation*", "scripts*"]
+exclude = ["resume-documentation*", "scripts*", "assets/images/*"]
 homepage = "https://github.com/DeveloperPaul123/modern-cv"
 repository = "https://github.com/DeveloperPaul123/modern-cv"
 
 [template]
 path = "template"
 entrypoint = "resume.typ"
-thumbnail = "resume.png"
+thumbnail = "assets/images/resume.png"