Skip to contents

Render a Quarto document as a Nix derivation

Source: R/derivs.R
rxp_qmd.Rd

Render a Quarto document as a Nix derivation

Usage

rxp_qmd(
  name,
  qmd_file,
  additional_files = "",
  nix_env = "default.nix",
  args = "",
  env_var = NULL
)

Arguments

name

Symbol, derivation name.

qmd_file

Character, path to .qmd file.

additional_files

Character vector, additional files to include, for example a folder containing images to include in the Quarto document.

nix_env

Character, path to the Nix environment file, default is "default.nix".

args

A character of additional arguments to be passed directly to the quarto command.

env_var

List, defaults to NULL. A named list of environment variables to set before running the Quarto render command, e.g., c(QUARTO_PROFILE = "production"). Each entry will be added as an export statement in the build phase.

Value

An object of class derivation which inherits from lists.

Details

To include built derivations in the document, rxp_read("derivation_name") should be put in the .qmd file.

See also

Other derivations: rxp_py(), rxp_py_file(), rxp_r(), rxp_r_file(), rxp_rmd()

Examples

if (FALSE) { # \dontrun{
  # Compile a .qmd file to a pdf using typst
  # `images` is a folder containing images to include in the Quarto doc
  rxp_qmd(
    name = report,
    qmd_file = "report.qmd",
    additional_files = "images",
    args = "--to typst"
  )
} # }