fix: import version in example

Update README example to use 0.4.0

.github/workflows/build-documentation.yml

@@ -7,7 +7,9 @@ jobs:
       - 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
+        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

README.md

@@ -27,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: (

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

@@ -7,6 +7,7 @@ dear = "Dear"
 cover-letter = "Cover Letter"
 attached = "Attached"
 curriculum-vitae = "Curriculum Vitae"
+sincerely = "Sincerely"
 
 [lang.de]
 resume = "Lebenslauf"
@@ -14,6 +15,7 @@ dear = "Sehr geehrte"
 cover-letter = "Anschreiben"
 attached = "Angehängt"
 curriculum-vitae = "Lebenslauf"
+sincerely = "Aufrichtig"
 
 [lang.gr]
 resume = "Βιογραφικό"
@@ -21,6 +23,15 @@ 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"
@@ -28,3 +39,20 @@ 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 = "Искренне"

lib.typ

@@ -1,4 +1,4 @@
-#import "@preview/fontawesome:0.1.0": *
+#import "@preview/fontawesome:0.2.1": *
 #import "@preview/linguify:0.4.0": *
 
 // const color
@@ -6,17 +6,24 @@
 #let color-darkgray = rgb("#333333")
 #let color-gray = rgb("#5d5d5d")
 #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),
+  fa-icon("linkedin", fill: color-darknight),
 )
 #let github-icon = box(
-  fa-icon("github", fa-set: "Brands", fill: color-darknight),
+  fa-icon("github", fill: color-darknight),
 )
-// for some reason this icon doesn't work with fa-icon, so we use the local version
+#let twitter-icon = box(
-#let phone-icon = box(image("assets/icons/square-phone-solid.svg"))
+  fa-icon("twitter", fill: color-darknight),
+)
+#let google-scholar-icon = box(
+  fa-icon("google-scholar", 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))
 
 /// Helpers
 
@@ -61,7 +68,7 @@
   set box(height: 11pt)
   
   align(right + horizon)[
-    #fa-icon("github", fa-set: "Brands", fill: color-darkgray) #link(
+    #fa-icon("github", fill: color-darkgray) #link(
       "https://github.com/" + github-path,
       github-path,
     )
@@ -150,7 +157,7 @@
   )
   
   set text(
-    font: ("Source Sans Pro"),
+    font: ("Source Sans Pro", "Source Sans 3"),
     lang: language,
     size: 11pt,
     fill: color-darkgray,
@@ -169,8 +176,11 @@
         #smallcaps[#date]
       ][
         #smallcaps[
-          #author.firstname
+          #if language == "zh" or language == "ja" [
-          #author.lastname
+            #author.firstname#author.lastname
+          ] else [
+            #author.firstname#sym.space#author.lastname
+          ]
           #sym.dot.c
           #linguify("resume", from: lang_data)
         ]
@@ -194,6 +204,7 @@
   )
   
   show heading.where(level: 1): it => [
+    
     #set block(
       above: 1em,
       below: 1em,
@@ -212,6 +223,7 @@
       #text[#strong[#text(color)[#it.body.text]]]
       #box(width: 1fr, line(length: 100%))
     ]
+    
   ]
   
   show heading.where(level: 2): it => {
@@ -241,11 +253,18 @@
             style: "normal",
             font: ("Roboto"),
           )
-          #text(fill: accent-color, weight: "thin")[#author.firstname]
+          #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 = {
@@ -266,11 +285,13 @@
   let address = {
     set text(
       size: 9pt,
-      weight: "bold",
+      weight: "regular",
     )
     align(center)[
+      #if ("address" in author) [
         #author.address
       ]
+    ]
   }
   
   let contacts = {
@@ -286,27 +307,43 @@
       )
       #block[
         #align(horizon)[
-          #if author.phone != none [
+          #if ("birth" in author) [
+            #birth-icon
+            #box[#text(author.birth)]
+            #separator
+          ]
+          #if ("phone" in author) [
             #phone-icon
             #box[#text(author.phone)]
             #separator
           ]
-          #if author.email != none [
+          #if ("email" in author) [
             #email-icon
             #box[#link("mailto:" + author.email)[#author.email]]
           ]
-          #if author.github != none [
+          #if ("github" in author) [
             #separator
             #github-icon
             #box[#link("https://github.com/" + author.github)[#author.github]]
           ]
-          #if author.linkedin != none [
+          #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]]
+          ]
         ]
       ]
     ]
@@ -338,15 +375,27 @@
 /// - 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: "",
+  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)
     #secondary-justified-header(description, date)
   ]
 }
@@ -431,7 +480,7 @@
   )
   
   set text(
-    font: ("Source Sans Pro"),
+    font: ("Source Sans Pro", "Source Sans 3"),
     lang: language,
     size: 11pt,
     fill: color-darkgray,
@@ -450,8 +499,11 @@
         #smallcaps[#date]
       ][
         #smallcaps[
-          #author.firstname
+          #if language == "zh" or language == "ja" [
-          #author.lastname
+            #author.firstname#author.lastname
+          ] else [
+            #author.firstname#sym.space#author.lastname
+          ]
           #sym.dot.c
           #linguify("cover-letter", from: lang_data)
         ]
@@ -499,9 +551,17 @@
             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]
           ]
+          
+        ]
       ]
     ]
   }
@@ -528,8 +588,10 @@
       fill: color-gray,
     )
     align(right)[
+      #if ("address" in author) [
         #author.address
       ]
+    ]
   }
   
   let contacts = {
@@ -548,21 +610,21 @@
           #stack(
             dir: ltr,
             spacing: 0.5em,
-            if author.phone != none [
+            if ("phone" in author) [
               #phone-icon
               #box[#text(author.phone)]
               #separator
             ],
-            if author.email != none [
+            if ("email" in author) [
               #email-icon
               #box[#link("mailto:" + author.email)[#author.email]]
             ],
-            if author.github != none [
+            if ("github" in author) [
               #separator
               #github-icon
               #box[#link("https://github.com/" + author.github)[#author.github]]
             ],
-            if author.linkedin != none [
+            if ("linkedin" in author) [
               #separator
               #linkedin-icon
               #box[
@@ -601,7 +663,10 @@
   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")[ #linguify(
             "attached",
@@ -646,7 +711,8 @@
 /// Letter heading for a given job position and addressee.
 /// - 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
@@ -655,7 +721,12 @@
   ]
   pad(top: 1em, bottom: 1em)[
     #text(weight: "light", fill: color-gray)[
-      #linguify("dear", from: lang_data) #addressee,
+      #if dear == "" [
+        #linguify("dear", from: lang_data)
+      ] else [
+        #dear
+      ]
+      #addressee,
     ]
   ]
 }

modern-cv-docs.typ

@@ -1,5 +1,5 @@
 #import "lib.typ"
-#import "@preview/tidy:0.2.0"
+#import "@preview/tidy:0.3.0"
 
 #let docs = tidy.parse-module(
   read("lib.typ"),

template/coverletter.typ

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

template/coverletter2.typ

@@ -1,4 +1,4 @@
-#import "@preview/modern-cv:0.2.0": *
+#import "@preview/modern-cv:0.5.0": *
 
 #show: coverletter.with(
   author: (
@@ -15,7 +15,7 @@
     ),
   ),
   profile-picture: none,
-  language: "en"
+  language: "sp",
 )
 
 #hiring-entity-info(entity-info: (

template/resume.typ

@@ -1,4 +1,4 @@
-#import "@preview/modern-cv:0.2.0": *
+#import "@preview/modern-cv:0.5.0": *
 
 #show: resume.with(
   author: (
@@ -7,6 +7,9 @@
     email: "js@example.com",
     phone: "(+1) 111-111-1111",
     github: "DeveloperPaul123",
+    twitter: "typstapp",
+    scholar: "",
+    birth: "January 1, 1990",
     linkedin: "Example",
     address: "111 Example St. Example City, EX 11111",
     positions: (
@@ -27,6 +30,7 @@
   location: "Example City, EX",
   date: "2019 - Present",
   description: "Example, Inc.",
+  title-link: "https://github.com/DeveloperPaul123",
 )
 
 #resume-item[

typst.toml

@@ -1,6 +1,6 @@
 [package]
 name = "modern-cv"
-version = "0.3.0"
+version = "0.5.0"
 compiler = "0.11.0"
 entrypoint = "lib.typ"
 authors = ["Paul Tsouchlos <https://github.com/DeveloperPaul123>"]