src/resume/guide.md

# Resume templates

A clean one-page resume (`basic-resume` 0.2.9) designed to be read well by applicant tracking
systems. It prints the name and contact line itself; the page holds the sections.

## Templates

### Resume
Use for a CV or resume. Parameters of `resume`:
- `author` (`""`): the name, printed as a large bold title.
- `author-position` (`left`), `personal-info-position` (`left`): alignment of name and contact line.
- Contact fields, each shown only when not `""`, joined with `|`: `pronouns`, `phone`, `location`,
  `email` (mailto link), `github`, `linkedin`, `personal-site` (written without `https://`, the
  link adds it), `orcid` (the ID only).
- `accent-color` (`"#000000"`): colour of headings and links, as a hex string.
- `font` (`"New Computer Modern"`), `font-size` (`10pt`), `author-font-size` (`20pt`),
  `paper` (`"us-letter"`), `lang` (`"en"`).

These values live in the header. Write the page body below it.

## Writing a page
- The name and contact line come from the header. Do not write them again, and do not use `=`
  headings (level 1 is reserved for the name).
- `==` is a section title (Education, Experience, Projects, Skills): small caps in the accent colour
  with a rule underneath.
- Inside a section, write one helper call per entry (`edu`, `work`, `project`, ...) followed by a
  `-` bullet list of achievements. Nested bullets (indent two spaces) work.
- For a skills section use bullets with a bold label: `- *Languages*: Python, Rust`.
- Text is justified. Links are underlined in the accent colour.
- Ligatures are off on purpose; build date ranges with `dates-helper` rather than typing dashes.
- Escape special characters in text: `\$`, `\#`, `\@`.

## Helpers
The header imports everything from the package.

`dates-helper(start-date: "", end-date: "")`: a date range joined by an em dash. Use it for every
`dates` argument.
```typ
#dates-helper(start-date: "Jan 2022", end-date: "Present")
```

`edu(institution: "", dates: "", degree: "", gpa: "", location: "", consistent: false)`: an
education entry. Bold institution with location on the right, then italic degree with italic dates
on the right. `consistent: true` puts dates top right and location bottom right like `work`. `gpa` is
accepted but not printed in this version; put a GPA in a bullet instead.
```typ
== Education
#edu(
  institution: "Example University",
  location: "Utrecht, Netherlands",
  dates: dates-helper(start-date: "Sep 2018", end-date: "Jul 2022"),
  degree: "BSc Computer Science",
)
- GPA: 3.8/4.0, graduated cum laude
```

`work(title: "", dates: "", company: "", location: "")`: a job. Bold title with dates on the right,
company with italic location below.
```typ
== Experience
#work(
  title: "Software Engineer",
  company: "Example Systems",
  location: "Amsterdam, Netherlands",
  dates: dates-helper(start-date: "Aug 2022", end-date: "Present"),
)
- Cut build times by 40% by caching dependencies
- Led a team of three on the reporting service
```

`project(role: "", name: "", url: "", dates: "")`: a project on one line. With `role` it reads
"**Role**, Name". `url` is written without `https://`; it is shown in brackets after the name when
`dates` is also given, otherwise on the right instead of dates.
```typ
== Projects
#project(
  name: "Scheduler",
  role: "Maintainer",
  url: "example.org",
  dates: dates-helper(start-date: "Nov 2023", end-date: "Present"),
)
- Open-source scheduler used by 7000+ students
```

`certificates(name: "", issuer: "", url: "", date: "")`: "**Name**, Issuer" with an optional link
(without `https://`) and the date on the right.
```typ
== Certificates
#certificates(name: "AWS Solutions Architect", issuer: "Amazon", date: "Oct 2024")
```

`extracurriculars(activity: "", dates: "")`: bold activity with dates on the right.
```typ
== Activities
#extracurriculars(
  activity: "Chess club captain",
  dates: dates-helper(start-date: "2020", end-date: "2022"),
)
- Organised a regional tournament with 120 players
```

`generic-two-by-two(top-left: "", top-right: "", bottom-left: "", bottom-right: "")` and
`generic-one-by-two(left: "", right: "")`: unformatted two-line or one-line rows with content pushed
left and right. Use them only for an entry no other helper fits.
```typ
#generic-one-by-two(left: [*Volunteer, Food Bank*], right: "2021")
```

## Do not
- Do not add `#set page`, `#set text`, `#set par` or font changes; size, font and margins come from
  the header.
- Do not pick your own colours (`fill:`, `rgb(...)`, `text(fill: ...)`); headings and links already
  use the accent colour.
- Do not build your own grids, tables, boxes or `#h(1fr)` rows for entries; use `edu`, `work`,
  `project`, `certificates`, `extracurriculars` or the generic helpers.
- Do not remove or edit the template header between `// znote:template` and `// znote:end`.
- Do not write the name or contact details in the body, and do not use `=` headings.
- Do not add icons, images, columns or a photo; the layout is a single plain column for applicant
  tracking systems.
- Keep it to one page unless the user asks for more.