kthayashi/qmdcv

Create a CV by inserting data into a Quarto (.qmd) document

qmdcv

Overview

This package facilitates creating a curriculum vitae (CV) with Quarto. The core functionality of the package is to convert structured data for a CV, supplied as a YAML file and/or lists in R, into Quarto’s flavor of Markdown text. This text can be inserted into a .qmd document and rendered as an HTML document with Quarto.

This package is intended primarily for personal use and was inspired by the vitae and datadrivencv packages.

Installation

Install qmdcv from GitHub:

# install.packages("remotes")
remotes::install_github("kthayashi/qmdcv")

To make use of the functionality of this package, you will need to install Quarto separately. If you are using a recent version of RStudio, Quarto may already be available to you. In addition, one function in this package (insert_pubs_web()) uses the Font Awesome Extension for Quarto - if you would like to use this function, you will need to install this extension to the root directory of your project.

Usage

Here’s a demonstration of qmdcv using the bundled cvdata:

library(qmdcv)
data(cvdata)

The family of insert() functions takes a list of one or more lists containing CV data and produces Markdown text in a select few formats. For example, education data can be provided as:

(edu <- cvdata$education)
#> [[1]]
#> [[1]]$title
#> [1] "Ph.D. in XXXXX"
#> 
#> [[1]]$start
#> [1] "YYYY"
#> 
#> [[1]]$end
#> [1] "YYYY"
#> 
#> [[1]]$details
#> [1] "University of XXXXX" "Advisor: Dr. XXXXX" 
#> 
#> 
#> [[2]]
#> [[2]]$title
#> [1] "B.S. in XXXXX"
#> 
#> [[2]]$start
#> [1] "YYYY"
#> 
#> [[2]]$end
#> [1] "YYYY"
#> 
#> [[2]]$details
#> [1] "XXXX College"

Expected usage is to enter CV data in a YAML file, which can be read into R using the yaml package. Here’s what the education data above would look like in YAML format:

cat(yaml::as.yaml(edu))
#> - title: Ph.D. in XXXXX
#>   start: YYYY
#>   end: YYYY
#>   details:
#>   - University of XXXXX
#>   - 'Advisor: Dr. XXXXX'
#> - title: B.S. in XXXXX
#>   start: YYYY
#>   end: YYYY
#>   details: XXXX College

Use insert() to produce Markdown text from the data in edu:

insert(edu)
#> ::::::{.columns}
#> :::{.column style='width:80%; text-align:left;'}
#> **Ph.D. in XXXXX**  
#> University of XXXXX  
#> Advisor: Dr. XXXXX  
#> :::
#> :::{.column style='width:20%; text-align:right;'}
#> YYYY - YYYY
#> :::
#> ::::::
#> 
#> ::::::{.columns}
#> :::{.column style='width:80%; text-align:left;'}
#> **B.S. in XXXXX**  
#> XXXX College  
#> :::
#> :::{.column style='width:20%; text-align:right;'}
#> YYYY - YYYY
#> :::
#> ::::::

Important: Use the Quarto option output: asis to ensure that the inserted Markdown text can be rendered properly.

See here for my personal CV built using qmdcv.

Disclaimers

This package is neither associated with nor endorsed by the Quarto open source project.