fix: layout

Co-authored-by: Carlo Rosso <carlorosso@Carlos-MacBook-Air.local>

.github/workflows/build-documentation.yml

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

.github/workflows/release.yml

@@ -0,0 +1,77 @@
+name: Package and push to registry repo
+on:
+  push:
+    tags: [ '*' ]
+
+env:
+  # the repository to which to push the release version
+  # usually a fork of typst/packages (https://github.com/typst/packages/)
+  # that you have push privileges to
+  REGISTRY_REPO: DeveloperPaul123/typst-packages
+  # the path within that repo where the "<name>/<version>" directory should be put
+  # for the Typst package registry, keep this as is
+  PATH_PREFIX: packages/preview
+
+jobs:
+  release:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Probe runner package cache
+        uses: awalsh128/cache-apt-pkgs-action@v1
+        with:
+          packages: cargo
+          version: 1.0
+
+      - name: Install just from crates.io
+        uses: baptiste0928/cargo-install@v3
+        with:
+          crate: just
+
+      - name: Setup typst
+        uses: typst-community/setup-typst@v3
+        with:
+          typst-version: latest
+
+      - name: Determine and check package metadata
+        run: |
+          . scripts/setup
+          echo "PKG_NAME=${PKG_PREFIX}" >> "${GITHUB_ENV}"
+          echo "PKG_VERSION=${VERSION}" >> "${GITHUB_ENV}"
+
+          if [[ "${GITHUB_REF_NAME}" != "${VERSION}" ]]; then
+            echo "package version ${VERSION} does not match release tag ${GITHUB_REF_NAME}" >&2
+            exit 1
+          fi
+
+      - name: Build package
+        run: |
+          just doc
+          just package out
+
+      - name: Checkout package registry
+        uses: actions/checkout@v4
+        with:
+          repository: ${{ env.REGISTRY_REPO }}
+          token: ${{ secrets.REGISTRY_TOKEN }}
+          path: typst-packages
+
+      - name: Release package
+        run: |
+          mkdir -p "typst-packages/${{ env.PATH_PREFIX }}/$PKG_NAME"
+          mv "out/${PKG_NAME}/${PKG_VERSION}" "typst-packages/${{ env.PATH_PREFIX }}/${PKG_NAME}"
+          rmdir "out/${PKG_NAME}"
+          rmdir out
+
+          GIT_USER_NAME="$(git log -1 --pretty=format:'%an')"
+          GIT_USER_EMAIL="$(git log -1 --pretty=format:'%ae')"
+
+          cd typst-packages
+          git config user.name "${GIT_USER_NAME}"
+          git config user.email "${GIT_USER_EMAIL}"
+          git checkout -b "${PKG_NAME}-${PKG_VERSION}"
+          git add .
+          git commit -m "${PKG_NAME}:${PKG_VERSION}"
+          git push --set-upstream origin "${PKG_NAME}-${PKG_VERSION}"

.github/workflows/tests.yml

@@ -0,0 +1,85 @@
+name: Tests
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  tests:
+    strategy:
+      matrix:
+        # add any other Typst versions that your package should support
+        typst-version: ["0.12", "0.13"]
+        # the docs don't need to build with all versions supported by the package;
+        # the latest one is enough
+        include:
+          - typst-version: "0.13"
+            doc: 1
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Probe runner package cache
+        uses: awalsh128/cache-apt-pkgs-action@v1
+        with:
+          packages: imagemagick cargo
+          version: 1.0
+
+      - name: Install oxipng from crates.io
+        uses: baptiste0928/cargo-install@v3
+        with:
+          crate: oxipng
+
+      - name: Install just from crates.io
+        uses: baptiste0928/cargo-install@v3
+        with:
+          crate: just
+
+      - name: Install tytanic
+        uses: taiki-e/cache-cargo-install-action@v2
+        with:
+          tool: tytanic@0.2.2
+
+      - name: Setup typst
+        uses: typst-community/setup-typst@v3
+        with:
+          typst-version: ${{ matrix.typst-version }}
+
+      - name: Install fonts
+        run: |
+          sudo apt update
+          sudo apt-get install fonts-roboto
+          ./scripts/install-fontawesome
+          ./scripts/install-source-sans
+          typst fonts
+
+      - name: Uninstall previous local install
+        run: just uninstall
+
+      - name: Run test suite
+        run: |
+          just install
+          tt run --font-path ~/.fonts --no-fail-fast
+
+      - name: Archive diffs
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: diffs-typst-${{ matrix.typst-version }}
+          path: |
+            tests/**/diff/*.png
+            tests/**/out/*.png
+            tests/**/ref/*.png
+          retention-days: 5
+
+      - name: Build docs
+        if: ${{ matrix.doc }}
+        run: just doc
+
+      - name: Upload docs
+        uses: actions/upload-artifact@v4
+        with:
+          name: manual
+          path: docs/manual.pdf

.gitignore

@@ -1 +1,3 @@
-*.pdf
+*.pdf
+tests/*/diff
+tests/*/out

.typstignore

@@ -0,0 +1,9 @@
+.github
+.fork
+scripts
+template/*.pdf
+.gitignore
+.issuetracker
+tests/*
+docs/*
+Justfile

Justfile

@@ -0,0 +1,57 @@
+root := justfile_directory()
+
+export TYPST_ROOT := root
+
+[private]
+default:
+    @just --list --unsorted
+
+# generate manual
+[doc('Generate package documentation')]
+[group('package')]
+doc:
+    typst compile docs/manual.typ docs/manual.pdf
+
+[doc('Run test suite. Requires tytanic.')]
+[group('dev')]
+test *args: install
+    tt run {{ args }} --use-system-fonts --no-fail-fast
+
+[doc('Update test cases. Requires tytanic.')]
+[group('dev')]
+update *args:
+    tt update {{ args }} --use-system-fonts
+
+[doc('Package the library into the specified destination folder')]
+[group('package')]
+package target:
+  ./scripts/package "{{target}}"
+
+[doc('Install the library with the "@local" prefix')]
+[group('dev')]
+install: (package "@local")
+
+[doc('Install the library with the "@preview" prefix (for pre-release testing)')]
+[group('dev')]
+install-preview: (package "@preview")
+
+[private]
+remove target:
+  ./scripts/uninstall "{{target}}"
+
+[doc('Uninstall the library from the "@local" prefix')]
+[group('dev')]
+uninstall: (remove "@local")
+
+[doc('Uninstall the library from the "@preview" prefix (for pre-release testing)')]
+[group('dev')]
+uninstall-preview: (remove "@preview")
+
+[doc('Format the source code. Requires typstyle.')]
+[group('dev')]
+format:
+    ./scripts/format
+
+[doc('Run ci suite')]
+[group('dev')]
+ci: test doc

README.md

@@ -1,14 +1,43 @@
-# Modern CV
+<h1 align="center">
+  <img src="assets/images/header.png" alt="Header">
+  <br><br>
+  Modern CV
+</h1>
 
 [![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)
+[![Tests](https://github.com/DeveloperPaul123/modern-cv/actions/workflows/tests.yml/badge.svg)](https://github.com/DeveloperPaul123/modern-cv/actions/workflows/tests.yml)  
 
 A port of the [Awesome-CV](https://github.com/posquit0/Awesome-CV) Latex resume template in [typst](https://github.com/typst/typst).
 
+## Features
+
+- Modern and clean design
+- Easy to use and customize (colors, profile picture, fonts, etc.)
+- Support for multiple sections (education, experience, skills, etc.)
+- Support for multiple languages
+
+## Preview
+
+| Resumes | Cover letters |
+| --- | --- |
+| ![Resume](assets/images/resume.png) | ![Cover Letter](assets/images/coverletter.png) |
+| ![Resume 2](assets/images/resume2.png) | ![Cover Letter 2](assets/images/coverletter2.png)|
+
 ## Requirements
 
+### Tools
+
+The following tools are used for the development of this template:
+
+- [typst](https://github.com/typst/typst)
+- [typst-test](https://github.com/tingerrr/typst-test) for running tests
+- [just](https://github.com/casey/just) for simplifying command running
+- [oxipng](https://github.com/shssoichiro/oxipng) for compressing thumbnails used in the README
+
+### Fonts
+
 You will need the `Roboto` and `Source Sans Pro` fonts installed on your system or available somewhere. If you are using the `typst` web app, no further action is necessary. You can download them from the following links:
 
 - [Roboto](https://fonts.google.com/specimen/Roboto)
@@ -27,7 +56,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.8.0": *
 
 #show: resume.with(
   author: (
@@ -43,7 +72,9 @@ Below is a basic example for a simple resume:
         "Software Architect"
       )
   ),
-  date: datetime.today().display()
+  profile-picture: none,
+  date: datetime.today().display(),
+  paper-size: "us-letter"
 )
 
 = Education
@@ -72,28 +103,23 @@ For more information on how to use and compile `typst` files, see the [official
 
 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](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).
+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://github.com/typst/typst#installation).
 
-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:
+With typst installed you can make changes to `lib.typ` and then `just install` or `just install-preview` to install the package locally. Change the import statements in the template files to point to the local package (if needed):
 
 ```typst
-#import "@local/modern-cv:0.3.0": *
+#import "@local/modern-cv:0.8.0": *
 ````
 
+If you use `just install-preview` you will only need to update the version number to match `typst.toml`.
+
 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.
+This project uses [typstyle](https://github.com/Enter-tainer/typstyle) to format the code. Run `just format` to format all the `*.typ` files in the project. Be sure to install `typstyle` before running the script.
 
 ## License
 

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>

docs/manual.typ

@@ -0,0 +1,7 @@
+#import "../lib.typ"
+#import "@preview/tidy:0.4.1"
+
+#let docs = tidy.parse-module(read("../lib.typ"), name: "Modern CV", scope: (
+  resume: lib,
+))
+#tidy.show-module(docs, style: tidy.styles.minimal)

docs/release-checklist.md

@@ -0,0 +1,13 @@
+# Release Checklist
+
+This document outlines the steps required to prepare a new release of `modern-cv`.
+
+Steps:
+
+1. Create a new release branch with the format `release/x.y.z`.
+2. Update the version in the `typst.toml`.
+3. Update examples in the [README.md](../README.md) to reflect the new version.
+4. Update templates to import the correct version.
+5. Do a final compilation/export check of all the templates.
+6. Ensure that tests pass.
+7. Ensure that the documentation manual builds.

lang.toml

@@ -7,6 +7,8 @@ dear = "Dear"
 cover-letter = "Cover Letter"
 attached = "Attached"
 curriculum-vitae = "Curriculum Vitae"
+sincerely = "Sincerely"
+letter-position-pretext = "Job Application for"
 
 [lang.de]
 resume = "Lebenslauf"
@@ -14,6 +16,8 @@ dear = "Sehr geehrte"
 cover-letter = "Anschreiben"
 attached = "Angehängt"
 curriculum-vitae = "Lebenslauf"
+sincerely = "Mit freundlichen Grüßen"
+letter-position-pretext = "Bewerbung für"
 
 [lang.gr]
 resume = "Βιογραφικό"
@@ -21,6 +25,17 @@ dear = "Αγαπητέ"
 cover-letter = "Συνοδευτική Επιστολή"
 attached = "Συνημμένο"
 curriculum-vitae = "Βιογραφικό"
+sincerely = "Με εκτίμηση"
+letter-position-pretext = "Αίτηση εργασίας για"
+
+[lang.pt]
+resume = "Currículo"
+dear = "Caro(a)"
+cover-letter = "Carta de Apresentação"
+attached = "Em anexo"
+curriculum-vitae = "Currículo"
+sincerely = "Atenciosamente"
+letter-position-pretext = "Candidatura a emprego para"
 
 [lang.sp]
 resume = "Currículum"
@@ -28,3 +43,41 @@ dear = "Estimado"
 cover-letter = "Carta de Presentación"
 attached = "Adjunto"
 curriculum-vitae = "Currículum"
+sincerely = "Sinceramente"
+letter-position-pretext = "Solicitud de empleo para"
+
+[lang.fr]
+resume = "Curriculum Vitae"
+dear = "Cher/Chère"
+cover-letter = "Lettre de motivation"
+attached = "Ci-joint"
+curriculum-vitae = "Curriculum Vitae"
+sincerely = "Sincèrement"
+letter-position-pretext = "Demande d'emploi pour"
+
+[lang.ru]
+resume = "Резюме"
+dear = "Уважаемый"
+cover-letter = "Сопроводительное письмо"
+attached = "Прилагается"
+curriculum-vitae = "Биографическая справка"
+sincerely = "Искренне"
+letter-position-pretext = "Заявление о приеме на работу"
+
+[lang.zh]
+resume = "简历"
+dear = "亲爱的"
+cover-letter = "求职信"
+attached = "附件"
+curriculum-vitae = "简历"
+sincerely = "真诚的"
+letter-position-pretext = "職位申請"
+
+[lang.it]
+resume = "Curriculum"
+dear = "Egregio"
+cover-letter = "Lettera di presentazione"
+attached = "Allegato"
+curriculum-vitae = "Curriculum Vitae"
+sincerely = "Cordiali saluti"
+letter-position-pretext = "Domanda di lavoro per"

modern-cv-docs.typ

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

scripts/format

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+set -eu
+find . -iname "*.typ" | xargs typstyle -i

scripts/format_typst.ps1

@@ -1,5 +0,0 @@
-# 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-fontawesome

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+set -eu
+
+wget -O ~/fontawesome.zip https://use.fontawesome.com/releases/v6.6.0/fontawesome-free-6.6.0-desktop.zip
+mkdir -p ~/fontawesome-fonts
+unzip ~/fontawesome.zip -d ~/fontawesome-fonts
+mkdir -p ~/.fonts
+find ~/fontawesome-fonts -type f -name "*.otf" -exec cp {} ~/.fonts \;
+rm ~/fontawesome.zip
+rm -rf ~/fontawesome-fonts
+fc-cache -f -v

scripts/install-source-sans

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+set -eu
+
+wget -O ~/source-sans.zip https://github.com/adobe-fonts/source-sans/releases/download/3.052R/OTF-source-sans-3.052R.zip
+mkdir -p ~/source-sans-fonts
+unzip ~/source-sans.zip -d ~/source-sans-fonts
+mkdir -p ~/.fonts
+find ~/source-sans-fonts -type f -name "*.otf" -exec cp {} ~/.fonts \;
+rm ~/source-sans.zip
+rm -rf ~/source-sans-fonts
+
+wget -O ~/source-sans-pro.zip https://github.com/adobe-fonts/source-sans-pro/archive/2.020R-ro/1.075R-it.zip
+mkdir -p ~/source-sans-pro-fonts
+unzip ~/source-sans-pro.zip -d ~/source-sans-pro-fonts
+mkdir -p ~/.fonts
+find ~/source-sans-pro-fonts -type f -name "*.otf" -exec cp {} ~/.fonts \;
+# clean up
+rm ~/source-sans-pro.zip
+rm -rf ~/source-sans-pro-fonts
+
+fc-cache -f -v

scripts/install_package_locally.ps1

@@ -1,10 +0,0 @@
-# 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
-Copy-Item -Path $Source -Destination $Destination -Recurse -Force

scripts/package

@@ -0,0 +1,86 @@
+#!/usr/bin/env bash
+set -eu
+
+# adapted from https://github.com/johannes-wolf/cetz/blob/35c0868378cea5ad323cc0d9c2f76de8ed9ba5bd/scripts/package
+# licensed under Apache License 2.0
+
+. "$(dirname "${BASH_SOURCE[0]}")/setup"
+
+if (( $# < 1 )) || [[ "${1:-}" == "help" ]]; then
+  echo "package TARGET"
+  echo ""
+  echo "Packages all relevant files into a directory named '<name>/<version>'"
+  echo "at TARGET. If TARGET is set to @local or @preview, the local Typst package"
+  echo "directory will be used so that the package gets installed for local use."
+  echo "The name and version are read from 'typst.toml' in the project root."
+  echo ""
+  echo "Local package prefix: $DATA_DIR/typst/package/local"
+  echo "Local preview package prefix: $DATA_DIR/typst/package/preview"
+  exit 1
+fi
+
+TARGET="$(resolve-target "${1:?Missing target path, @local or @preview}")"
+echo "Install dir: $TARGET"
+
+# ignore rules
+readarray -t ignores < <(grep -v '^#' .typstignore | grep '[^[:blank:]]')
+
+# recursively print all files that are not excluded via .typstignore
+function enumerate {
+    local root="$1"
+    if [[ -f "$root" ]]; then
+        echo "$root"
+    else
+        local files
+        readarray -t files < <(find "$root" \
+      -mindepth 1 -maxdepth 1 \
+      -not -name .git \
+      -not -name .typstignore)
+        # declare -p files >&2
+
+        local f
+        for f in "${files[@]}"; do
+            local include
+            include=1
+
+            local ignore
+            for ignore in "${ignores[@]}"; do
+                if [[ "$ignore" =~ ^! ]]; then
+                    ignore="${ignore:1}"
+                    if [[ "$f" == ./$ignore ]]; then
+                        # echo "\"$f\" matched \"!$ignore\"" >&2
+                        include=1
+                    fi
+                elif [[ "$f" == ./$ignore ]]; then
+                    # echo "\"$f\" matched \"$ignore\"" >&2
+                    include=0
+                fi
+            done
+            if [[ "$include" == 1 ]]; then
+                enumerate "$f"
+            fi
+        done
+    fi
+}
+
+# List of all files that get packaged
+readarray -t files < <(enumerate ".")
+# declare -p files >&2
+
+TMP="$(mktemp -d)"
+
+for f in "${files[@]}"; do
+  mkdir -p "$TMP/$(dirname "$f")" 2>/dev/null
+  cp -r "$ROOT/$f" "$TMP/$f"
+done
+
+TARGET="${TARGET:?}/${PKG_PREFIX:?}/${VERSION:?}"
+echo "Packaged to: $TARGET"
+if rm -r "${TARGET:?}" 2>/dev/null; then
+  echo "Overwriting existing version."
+fi
+mkdir -p "$TARGET"
+
+# include hidden files by setting dotglob
+shopt -s dotglob
+mv "$TMP"/* "$TARGET"

scripts/setup

@@ -0,0 +1,37 @@
+# source this script to prepare some common environment variables
+
+# adapted from https://github.com/johannes-wolf/cetz/blob/35c0868378cea5ad323cc0d9c2f76de8ed9ba5bd/scripts/package
+# licensed under Apache License 2.0
+
+# Local package directories per platform
+if [[ "$OSTYPE" == "linux"* ]]; then
+  DATA_DIR="${XDG_DATA_HOME:-$HOME/.local/share}"
+elif [[ "$OSTYPE" == "darwin"* ]]; then
+  DATA_DIR="$HOME/Library/Application Support"
+else
+  DATA_DIR="${APPDATA}"
+fi
+
+function read-toml() {
+  local file="$1"
+  local key="$2"
+  # Read a key value pair in the format: <key> = "<value>"
+  # stripping surrounding quotes.
+  perl -lne "print \"\$1\" if /^${key}\\s*=\\s*\"(.*)\"/" < "$file"
+}
+
+ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")"; pwd -P)/.." # macOS has no realpath
+PKG_PREFIX="$(read-toml "$ROOT/typst.toml" "name")"
+VERSION="$(read-toml "$ROOT/typst.toml" "version")"
+
+function resolve-target() {
+  local target="$1"
+
+	if [[ "$target" == "@local" ]]; then
+		echo "${DATA_DIR}/typst/packages/local"
+	elif [[ "$target" == "@preview" ]]; then
+		echo "${DATA_DIR}/typst/packages/preview"
+	else
+		echo "$target"
+	fi
+}

scripts/uninstall

@@ -0,0 +1,33 @@
+#!/usr/bin/env bash
+set -eu
+
+# adapted from https://github.com/johannes-wolf/cetz/blob/35c0868378cea5ad323cc0d9c2f76de8ed9ba5bd/scripts/package
+# licensed under Apache License 2.0
+
+. "$(dirname "${BASH_SOURCE[0]}")/setup"
+
+if (( $# < 1 )) || [[ "${1:-}" == "help" ]]; then
+  echo "uninstall TARGET"
+  echo ""
+  echo "Removes the package installed into a directory named '<name>/<version>'"
+  echo "at TARGET. If TARGET is set to @local or @preview, the local Typst package"
+  echo "directory will be used so that the package gets installed for local use."
+  echo "The name and version are read from 'typst.toml' in the project root."
+  echo ""
+  echo "Local package prefix: $DATA_DIR/typst/package/local"
+  echo "Local preview package prefix: $DATA_DIR/typst/package/preview"
+  exit 1
+fi
+
+TARGET="$(resolve-target "${1:?Missing target path, @local or @preview}")"
+echo "Install dir: $TARGET"
+
+TARGET="${TARGET:?}/${PKG_PREFIX:?}/${VERSION:?}"
+echo "Package to uninstall: $TARGET"
+if [[ ! -e "${TARGET:?}" ]]; then
+  echo "Package was not found."
+elif rm -r "${TARGET:?}" 2>/dev/null; then
+  echo "Successfully removed."
+else
+  echo "Removal failed."
+fi

scripts/update_thumbnails.ps1

@@ -2,4 +2,4 @@ typst compile -f png $PSScriptRoot/../template/resume.typ $PSScriptRoot/../asset
 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/*
+oxipng.exe $PSScriptRoot/../assets/images/*.png

template/coverletter.typ

@@ -1,35 +1,47 @@
-#import "@preview/modern-cv:0.2.0": *
+#import "@preview/modern-cv:0.8.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",
+    website: "https://www.github.com/DeveloperPaul123",
     positions: (
       "Software Engineer",
       "Full Stack Developer",
     ),
   ),
   profile-picture: image("./profile.png"),
+  // change this to match the language available in 'lang.toml'
   language: "en",
+  font: "Times New Roman",
+  // Remove the following line to show the footer
+  // Or set the value to `true`
+  show-footer: false,
+  // this defaults to false
+  show-address-icon: true,
+  // set this to `none` to show the default or remove it completely
+  closing: [],
+  // see typst "page" documentation for more options
+  paper-size: "us-gov-legal",
 )
 
-#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",
+#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")
+
 = About Me
 #coverletter-content[
   #lorem(80)

template/coverletter2.typ

@@ -1,10 +1,11 @@
-#import "@preview/modern-cv:0.2.0": *
+#import "@preview/modern-cv:0.8.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",
@@ -13,23 +14,29 @@
       "Software Engineer",
       "Full Stack Developer",
     ),
+    custom: (
+      (
+        text: "Youtube Channel",
+        icon: "youtube",
+        link: "http://example.com",
+      ),
+    ),
   ),
   profile-picture: none,
-  language: "en"
+  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",
+#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)
 ]

template/resume.typ

@@ -1,12 +1,17 @@
-#import "@preview/modern-cv:0.2.0": *
+#import "@preview/modern-cv:0.8.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: (
@@ -14,10 +19,21 @@
       "Software Architect",
       "Developer",
     ),
+    custom: (
+      (
+        text: "Youtube Channel",
+        icon: "youtube",
+        link: "https://example.com",
+      ),
+    ),
   ),
+  profile-picture: image("profile.png"),
   date: datetime.today().display(),
   language: "en",
   colored-headers: true,
+  show-footer: false,
+  show-address-icon: true,
+  paper-size: "us-letter",
 )
 
 = Experience
@@ -27,6 +43,7 @@
   location: "Example City, EX",
   date: "2019 - Present",
   description: "Example, Inc.",
+  title-link: "https://github.com/DeveloperPaul123",
 )
 
 #resume-item[
@@ -42,6 +59,13 @@
   description: "Previous Company, Inc.",
 )
 
+#resume-item[
+  // content doesn't have to be bullet points
+  #lorem(72)
+]
+
+#resume-entry(title: "Intern", location: "Example City, EX")
+
 #resume-item[
   - #lorem(20)
   - #lorem(15)
@@ -77,14 +101,62 @@
 = Skills
 
 #resume-skill-item(
-  "Languages",
-  (strong("C++"), strong("Python"), "Java", "C#", "JavaScript", "TypeScript"),
+  "Programming Languages",
+  (
+    strong("C++"),
+    strong("Python"),
+    "Rust",
+    "Java",
+    "C#",
+    "JavaScript",
+    "TypeScript",
+  ),
 )
 #resume-skill-item("Spoken Languages", (strong("English"), "Spanish"))
 #resume-skill-item(
   "Programs",
-  (strong("Excel"), "Word", "Powerpoint", "Visual Studio"),
+  (
+    strong("Excel"),
+    "Word",
+    "Powerpoint",
+    "Visual Studio",
+  ),
 )
+// spacing fix, not needed if you use `resume-skill-grid`
+#block(below: 0.65em)
+
+// An alternative way of list out your resume skills
+// #resume-skill-grid(
+//   categories_with_values: (
+//     "Programming Languages": (
+//       strong("C++"),
+//       strong("Python"),
+//       "Rust",
+//       "Java",
+//       "C#",
+//       "JavaScript",
+//       "TypeScript",
+//     ),
+//     "Spoken Languages": (
+//       strong("English"),
+//       "Spanish",
+//       "Greek",
+//     ),
+//     "Programs": (
+//       strong("Excel"),
+//       "Word",
+//       "Powerpoint",
+//       "Visual Studio",
+//       "git",
+//       "Zed"
+//     ),
+//     "Really Really Long Long Long Category": (
+//       "Thing 1",
+//       "Thing 2",
+//       "Thing 3"
+//     )
+//   ),
+// )
 
 = Education
 

tests/resume/test.typ

@@ -0,0 +1,64 @@
+#import "@local/modern-cv:0.8.0": *
+
+// setup the document like we do for the resume
+#let font = "Source Sans 3"
+#set text(font: font, size: 11pt, fill: color-darkgray, fallback: true)
+
+#set page(
+  paper: "a4",
+  margin: (left: 15mm, right: 15mm, top: 10mm, bottom: 10mm),
+  footer: [],
+  footer-descent: 0pt,
+)
+
+// set paragraph spacing
+#set par(spacing: 0.75em, justify: true)
+
+#set heading(numbering: none, outlined: false)
+
+#show heading.where(level: 1): it => [
+
+  #set block(above: 1em, below: 1em)
+  #set text(size: 16pt, weight: "regular")
+
+  #align(left)[
+    #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")
+  it.body
+}
+
+#show heading.where(level: 3): it => {
+  set text(size: 10pt, weight: "regular")
+  smallcaps[#it.body]
+}
+
+// test the resume functions
+
+#resume-item("Education")
+
+#resume-entry(
+  title: "BSc Computer Science",
+  location: "Example City",
+  date: "2019 - 2022",
+  description: "Achieved acaademic honors and awards.",
+)
+
+// resume-entry also support omitting the date and description
+#resume-entry(title: "Title", location: "Location")
+
+#resume-certification("Certified Scrum Master (CSM)", "Jan 2022")
+
+#resume-skill-item("Programming", (strong["C++"], "Python", "Java"))
+
+#resume-gpa("3.5", "4.0")

tests/utilities/test.typ

@@ -0,0 +1,68 @@
+#import "@local/modern-cv:0.8.0": *
+
+// setup the document like we do for the resume
+#let font = "Source Sans 3"
+#set text(font: font, size: 11pt, fill: color-darkgray, fallback: true)
+
+#set page(
+  paper: "a4",
+  margin: (left: 15mm, right: 15mm, top: 10mm, bottom: 10mm),
+  footer: [],
+  footer-descent: 0pt,
+)
+
+// set paragraph spacing
+#set par(spacing: 0.75em, justify: true)
+
+#set heading(numbering: none, outlined: false)
+
+#show heading.where(level: 1): it => [
+
+  #set block(above: 1em, below: 1em)
+  #set text(size: 16pt, weight: "regular")
+
+  #align(left)[
+    #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")
+  it.body
+}
+
+#show heading.where(level: 3): it => {
+  set text(size: 10pt, weight: "regular")
+  smallcaps[#it.body]
+}
+
+#justified-header("Modern CV", "A modern curriculum vitae template")
+
+#secondary-justified-header("Created by", "DeveloperPaul123")
+
+#github-link("DeveloperPaul123/modern-cv")
+#linkedin-icon
+#github-icon
+#twitter-icon
+#google-scholar-icon
+#orcid-icon
+#phone-icon
+#email-icon
+#birth-icon
+#homepage-icon
+#website-icon
+#gitlab-icon
+#bitbucket-icon
+
+#square(size: 1em, fill: color-darkgray)
+#square(size: 1em, fill: color-darknight)
+#square(size: 1em, fill: color-gray)
+#square(size: 1em, fill: default-accent-color)
+#square(size: 1em, fill: default-location-color)

typst.toml

@@ -1,7 +1,7 @@
 [package]
 name = "modern-cv"
-version = "0.3.0"
-compiler = "0.11.0"
+version = "0.8.0"
+compiler = "0.12.0"
 entrypoint = "lib.typ"
 authors = ["Paul Tsouchlos <https://github.com/DeveloperPaul123>"]
 license = "MIT"
@@ -10,7 +10,6 @@ keywords = ["CV", "Curriculum Vitae", "Resume", "Minimalistic", "Professional",
 categories = ["cv"]
 disciplines = []
 exclude = ["resume-documentation*", "scripts*", "assets/images/*"]
-homepage = "https://github.com/DeveloperPaul123/modern-cv"
 repository = "https://github.com/DeveloperPaul123/modern-cv"
 
 [template]