|
| 1 | +# Finely Crafted CV Template |
| 2 | + |
| 3 | +This Typst template provides a clean and professional format for creating a |
| 4 | +curriculum vitae (CV) or résumé. It comes with functions and styles to help you |
| 5 | +easily generate a well-structured document, complete with sections for |
| 6 | +education, experience, skills, and more. |
| 7 | + |
| 8 | +## Features |
| 9 | + |
| 10 | +- **Modern Design:** Aesthetic and professional layout designed for readability. |
| 11 | +- **Responsive Header & Footer:** Includes contact information dynamically. |
| 12 | + |
| 13 | +## Usage |
| 14 | + |
| 15 | +To use this template, import it with the version number and utilize the `resume` or `cv` function: |
| 16 | + |
| 17 | +```typst |
| 18 | +#import "@preview/finely-crafted-cv:0.2.0": * |
| 19 | +
|
| 20 | +#show: resume.with( |
| 21 | + name: "Amira Patel", |
| 22 | + tagline: "Innovative marine biologist with 15+ years of experience in ocean conservation and research.", |
| 23 | + keywords: "marine biology, conservation, research, education, patents", |
| 24 | + email: "amira.patel@oceandreams.org", |
| 25 | + phone: "+1-305-555-7890", |
| 26 | + linkedin-username: "amirapatel", |
| 27 | + thumbnail: image("assets/my-qr-code.svg"), |
| 28 | +) |
| 29 | +
|
| 30 | += Introduction |
| 31 | +
|
| 32 | +#lorem(100) |
| 33 | +
|
| 34 | += Experience |
| 35 | +
|
| 36 | +#company-heading("Some Company", start: "March 2018", end: "Present", icon: image("icons/earth.svg"))[ |
| 37 | + #job-heading("Some Job", location: "Some Location")[ |
| 38 | + - Here is an achievement |
| 39 | + - Here's another one. |
| 40 | + ] |
| 41 | + // companies can have multiple jobs |
| 42 | + #job-heading("First Job", location: "Some Location")[ |
| 43 | + - Here is an achievement |
| 44 | + - Here's another one. |
| 45 | + ] |
| 46 | +] |
| 47 | +
|
| 48 | +// for companies which have less detail, you can use the `comment` instead of a |
| 49 | +// body of tasks, as follows: |
| 50 | +#company-heading("Another Company", start: "July 2005", end: "August 2009", icon: image("icons/microscope.svg"))[ |
| 51 | + #job-heading("Another Job", location: "Another Location", |
| 52 | + comment: [Contributed to 7 published studies. #footnote[Visit https://amirapatel.org/publications for full list of publications.]] |
| 53 | + )[] |
| 54 | +] |
| 55 | +
|
| 56 | += Education |
| 57 | +
|
| 58 | +// school-heading is an alias for company-heading, accepts the same parameters as company-heading |
| 59 | +#school-heading("University of California, San Diego", start: "Fall 2001", end: "Spring 2005", icon: image("icons/graduation-cap.svg"))[ |
| 60 | + // degree-heading is an alias for job-heading, accepts the same parameters as job-heading |
| 61 | + #degree-heading("Ph.D. in Marine Biology")[] |
| 62 | +] |
| 63 | +``` |
| 64 | + |
| 65 | +## Functions and Parameters |
| 66 | + |
| 67 | +### `resume` or `cv` |
| 68 | + |
| 69 | +This is the main function to create a CV document. |
| 70 | + |
| 71 | +- **Parameters:** |
| 72 | + - `name`: (String) Your full name. Default is "YOUR NAME HERE". |
| 73 | + - `tagline`: (String) A brief description of your professional identity or mission. |
| 74 | + - `paper`: (String) The paper size, default is "us-letter". |
| 75 | + - `heading-font`: (Font) Font for headings, customizable. |
| 76 | + - `body-font`: (Font) Font for body text, customizable. |
| 77 | + - `body-size`: (Size) Font size for body text. |
| 78 | + - `email`: (String) Your email address. |
| 79 | + - `phone`: (String) Your phone number. |
| 80 | + - `linkedin-username`: (String) Your LinkedIn username. |
| 81 | + - `keywords`: (String) Keywords for searchability. |
| 82 | + - `thumbnail`: (Image) Thumbnail or QR code image, optional. |
| 83 | + - `body`: (Block) The main content of your CV. |
| 84 | + |
| 85 | +### `company-heading` |
| 86 | + |
| 87 | +Used to create a heading for a company or organization. |
| 88 | + |
| 89 | +- **Parameters:** |
| 90 | + - `name`: (String) Name of the company. |
| 91 | + - `start`: (String) Start date. |
| 92 | + - `end`: (String) End date, optional. |
| 93 | + - `icon`: (Image) Icon image associated with the company, optional. |
| 94 | + - `body`: (Block) Content related to the company role or tasks. |
| 95 | + |
| 96 | +### `job-heading` |
| 97 | + |
| 98 | +Defines a job title within a company heading. |
| 99 | + |
| 100 | +- **Parameters:** |
| 101 | + - `title`: (String) Job title. |
| 102 | + - `location`: (String) Location of the job, optional. |
| 103 | + - `start`: (String) Start date, optional. |
| 104 | + - `end`: (String) End date, optional. |
| 105 | + - `comment`: (String) Additional comments or notes, optional. |
| 106 | + - `body`: (Block) Tasks or responsibilities. |
| 107 | + |
| 108 | +### `school-heading` |
| 109 | + |
| 110 | +Alias for `company-heading`, used for educational institutions. |
| 111 | + |
| 112 | +### `degree-heading` |
| 113 | + |
| 114 | +Alias for `job-heading`, used for academic degrees or certifications. |
| 115 | + |
| 116 | +## License |
| 117 | + |
| 118 | +This template is released under the MIT License. |
0 commit comments