imprecv Documentation

repository·main·Indexed 19 days ago

https://github.com/jskherman/imprecv

A Typst-based CV template that separates content from data using a YAML file for input. Based on recommendations from the r/EngineeringResumes wiki, it allows for easy version control of personal information and can be used via the Typst CLI or typst.app.

Tokens
455
Snippets
1
Records
4
Agent score
18%

What's inside imprecv

  1. Overview of imprecv

    main
    imprecv is a no-frills curriculum vitae (CV) template for Typst. It uses a YAML file for data input, allowing users to version control their CV data easily. The template is based on recommendations from the r/EngineeringResumes wiki and a popular Reddit template.
  2. How imprecv works: Content files and Data

    main

    imprecv is designed to be used by importing the package entrypoint cv.typ into a dedicated "content" file (e.g., template.typ).

    In your content file, you will:

    1. Import the template: Use #import "imprecv/cv.typ": * (or the equivalent package import).
    2. Apply styles: Call functions provided by the template to apply document styles.
    3. Show components: Use template functions to render CV components (like experience or education sections).
    4. Load data: Use functions to load your CV data from a YAML file (e.g., template.yml).

    You can customize your CV by modifying style variables or overriding existing function implementations directly within your content file.

  3. Set up imprecv using typst.app

    main

    To use imprecv in the web-based Typst app, you can use the template feature:

    1. From the Typst Dashboard, select "Start from template".
    2. Search for and choose the imprecv template.
    3. Name your project and click "Create".

    Alternatively, you can click the Create project in app button in Typst Universe to automatically create a new project with the template.

  4. Set up imprecv using Typst CLI

    main

    The recommended way to use imprecv with the Typst CLI is to initialize a new project using the package manager. This creates the necessary files to get started immediately.

    1. Run the initialization command:
      typst init @preview/imprecv:1.0.1
    2. Compile your CV to PDF:
      typst compile template.typ
    typst init @preview/imprecv:1.0.1
    typst compile template.typ