Help pages

-- C -- cover_letter()

-- L -- liteformats liteformats-package

-- R -- resume()

-- U -- use_resume() use_cover_letter()

1 Lightweight output formats for litedown

Description

Provides HTML-first resume and cover-letter formats with self-contained styling, local pages.js pagination, and optional PDF output through a headless Chromium-based browser.

Details

Start with use_resume() or use_cover_letter(), then render with resume() or cover_letter().

Author(s)

Maintainer: Nan Xiao me@nanx.me (ORCID) [copyright holder]

Authors:

Other contributors:

See Also

Useful links:

2 Render a cover letter

Description

Render a two-column cover letter to self-contained HTML or PDF. The narrow left column holds the sender's details, while the letter remains the visual foreground in the wider right column.

Usage

cover_letter(
  input,
  output = NULL,
  author = NULL,
  address = NULL,
  phone = NULL,
  email = NULL,
  website = NULL,
  date = NULL,
  greeting = NULL,
  font_family = NULL,
  google_font = NULL,
  font_files = NULL,
  font_size = NULL,
  font_scale = NULL,
  ligatures = NULL,
  line_height = NULL,
  paragraph_spacing = NULL,
  section_spacing = NULL,
  margins = NULL,
  paper = NULL,
  link_color = NULL,
  paged = NULL,
  keep_html = FALSE,
  browser = NULL,
  envir = parent.frame()
)

Arguments

input

Path to a .Rmd or .md source document.

output

Output path ending in .html or .pdf. If NULL, an HTML file is created beside input.

author, address, phone, email, website

Contact metadata. NULL uses the corresponding value in the source document's YAML header.

date, greeting

Letter date and salutation. NULL uses YAML metadata.

font_family

A CSS font-family value. For example, "Charter, Georgia, serif".

google_font

A Google Fonts family name or a full Google Fonts CSS URL. This is an explicit online resource and is never used by default. A family name loads its default face; pass a full URL plus the matching font_family when specific axes or weights are required.

font_files

A named character vector or list of local font files. Names may be regular, italic, bold, and bold_italic. Relative paths are resolved from the source document. Fonts are embedded in the HTML.

font_size

A CSS length such as "11pt".

font_scale

A positive number used to scale font_size. This is useful when replacing a font with different metrics.

ligatures

Whether to enable common and discretionary ligatures. Defaults to FALSE for more predictable text extraction from PDFs.

line_height

A positive unitless CSS line height or CSS length.

paragraph_spacing, section_spacing

CSS lengths controlling vertical rhythm.

margins

Page margins. Supply one to four CSS lengths using standard CSS shorthand order, or numeric values interpreted as inches.

paper

A paper name ("letter", "a4", or "legal") or a two-element vector containing width and height as CSS lengths.

link_color

Any valid CSS color.

paged

Whether the HTML preview should open in a paginated layout. Printing always invokes the packaged pages.js pagination.

keep_html

For PDF output, whether to retain the intermediate HTML beside the PDF.

browser

Path to Chromium, Google Chrome, or Microsoft Edge. NULL lets xfun::browser_print() discover it.

envir

Environment in which R code in input is evaluated.

Value

The normalized output path, invisibly.

Examples

source <- use_cover_letter(tempfile(fileext = ".Rmd"))
cover_letter(source, tempfile(fileext = ".html"))

# PDF output requires a local Chromium-based browser
cover_letter(source, "cover-letter.pdf")

3 Render a resume

Description

Render a Markdown or R Markdown resume to a self-contained HTML document or to PDF through a headless Chromium-based browser. The output format is inferred from the extension of output.

Usage

resume(
  input,
  output = NULL,
  author = NULL,
  job_title = NULL,
  address = NULL,
  phone = NULL,
  email = NULL,
  website = NULL,
  linkedin = NULL,
  font_family = NULL,
  google_font = NULL,
  font_files = NULL,
  font_size = NULL,
  font_scale = NULL,
  ligatures = NULL,
  line_height = NULL,
  paragraph_spacing = NULL,
  section_spacing = NULL,
  margins = NULL,
  paper = NULL,
  link_color = NULL,
  paged = NULL,
  keep_html = FALSE,
  browser = NULL,
  envir = parent.frame()
)

Arguments

input

Path to a .Rmd or .md source document.

output

Output path ending in .html or .pdf. If NULL, an HTML file is created beside input.

author, address, phone, email, website

Contact metadata. NULL uses the corresponding value in the source document's YAML header.

job_title, linkedin

Resume-specific professional and contact metadata.

font_family

A CSS font-family value. For example, "Charter, Georgia, serif".

google_font

A Google Fonts family name or a full Google Fonts CSS URL. This is an explicit online resource and is never used by default. A family name loads its default face; pass a full URL plus the matching font_family when specific axes or weights are required.

font_files

A named character vector or list of local font files. Names may be regular, italic, bold, and bold_italic. Relative paths are resolved from the source document. Fonts are embedded in the HTML.

font_size

A CSS length such as "11pt".

font_scale

A positive number used to scale font_size. This is useful when replacing a font with different metrics.

ligatures

Whether to enable common and discretionary ligatures. Defaults to FALSE for more predictable text extraction from PDFs.

line_height

A positive unitless CSS line height or CSS length.

paragraph_spacing, section_spacing

CSS lengths controlling vertical rhythm.

margins

Page margins. Supply one to four CSS lengths using standard CSS shorthand order, or numeric values interpreted as inches.

paper

A paper name ("letter", "a4", or "legal") or a two-element vector containing width and height as CSS lengths.

link_color

Any valid CSS color.

paged

Whether the HTML preview should open in a paginated layout. Printing always invokes the packaged pages.js pagination.

keep_html

For PDF output, whether to retain the intermediate HTML beside the PDF.

browser

Path to Chromium, Google Chrome, or Microsoft Edge. NULL lets xfun::browser_print() discover it.

envir

Environment in which R code in input is evaluated.

Details

Document metadata and typographic settings may be supplied in the YAML header. Renderer arguments take precedence over YAML. See use_resume() for a complete starter document.

Value

The normalized output path, invisibly.

Examples

source <- use_resume(tempfile(fileext = ".Rmd"))
resume(source, tempfile(fileext = ".html"))

# PDF output requires a local Chromium-based browser
resume(source, "resume.pdf")

# Embed local font files
resume(
  source,
  font_files = c(
    regular = "fonts/MySerif-Regular.woff2",
    italic = "fonts/MySerif-Italic.woff2",
    bold = "fonts/MySerif-Bold.woff2"
  ),
  font_scale = 0.96,
  ligatures = FALSE
)

4 Create a resume or cover letter from a starter

Description

Copy an editable R Markdown starter document to path. Static assets used by the rendered formats remain inside the installed package; the copied source contains only Markdown content and YAML settings.

Usage

use_resume(path = "resume.Rmd", overwrite = FALSE)

use_cover_letter(path = "cover-letter.Rmd", overwrite = FALSE)

Arguments

path

Destination path.

overwrite

Whether to replace an existing file.

Value

The normalized destination path, invisibly.

Examples

use_resume(tempfile(fileext = ".Rmd"))
use_cover_letter(tempfile(fileext = ".Rmd"))