Recipes

Adding a New Module

1. Create a new file, e.g. modules_en/volunteering.typ
2. Add your imports and content (sections, entries, etc.)
3. In cv.typ, add "volunteering" to the import-modules call

Language Override at Compile Time

typst compile cv.typ --input language=fr

For Chinese, Japanese, Korean, or Russian, also configure [lang.non_latin] in metadata.toml with name and font.

Skills with Inline Separators

Use #h-bar() to separate skill items within cv-skill:

#cv-skill(
  type: [Tech Stack],
  info: [Python #h-bar() SQL #h-bar() Tableau #h-bar() AWS],
)

Adding a Profile Photo

The profile photo is passed as an argument to cv() in your cv.typ, not set in metadata.toml:

#show: cv.with(
  metadata,
  profile-photo: image("assets/avatar.png"),
)

Control the shape with profile_photo_radius in [layout.header]:

• "50%" — circle (default)
• "0%" — square
• "10%" — rounded corners

Set display_profile_photo = false in [layout.header] to hide the photo entirely.

Custom Contact Icon with Image

To add a custom contact entry with an image icon (instead of a Font Awesome icon):

1. Define the entry in metadata.toml with an awesomeIcon fallback:

   [personal.info.custom-1]
   awesomeIcon = "graduation-cap"
   text = "PhD in Data Science"
   link = "https://example.com"
   

2. Pass the image in cv.typ via the custom-icons parameter (the key must match custom-1):

   #show: cv.with(
     metadata,
     profile-photo: image("assets/avatar.png"),
     custom-icons: (
       "custom-1": image("assets/my-icon.png"),
     ),
   )
   

When a custom-icons entry is provided, it takes priority over the awesomeIcon value from TOML.

Color Customization

Preset Colors

Set awesome_color in [layout] to one of the built-in presets:

Name	Hex
skyblue	#0395DE
red	#DC3522
nephritis	#27AE60
concrete	#95A5A6
darknight	#131A28

[layout]
awesome_color = "nephritis"

Custom Hex Color

Pass any hex color string directly:

[layout]
awesome_color = "#1E90FF"

Cover Letter with Signature

Create a cover letter with a signature image at the bottom:

#import "@preview/brilliant-cv:3.2.0": letter

#let metadata = toml("metadata.toml")

#show: letter.with(
  metadata,
  sender-address: "123 Main Street, City, State 12345",
  recipient-name: "ABC Company",
  recipient-address: "456 Business Ave, City, State 67890",
  date: datetime.today().display(),
  subject: "Application for Data Analyst Position",
  signature: image("assets/signature.png"),
)

Dear Hiring Manager,

// Your letter content here...

Sincerely,

Leave signature as "" (default) to omit the signature image.

CI/CD with GitHub Actions

A minimal workflow to compile your CV on every push:

name: Build CV

on: [push]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Setup Typst
        uses: typst-community/setup-typst@v4

      - name: Compile CV
        run: typst compile cv.typ cv.pdf

      - name: Upload PDF
        uses: actions/upload-artifact@v4
        with:
          name: cv
          path: cv.pdf

Tip

If your CV uses custom fonts, add a step to install them before compiling. See the Troubleshooting page for font issues.