local_siteyaml: Temporarily create muggle default vignettes/_site.yml file

In subugoe/muggle: Opinionated Devops for R Data Products Strictly Without Magic

Description

Upgrades vignettes to muggle default. Wraps local_muggle_file() to delete file upon use.

Usage

local_siteyaml(.local_envir = parent.frame())

Arguments

.local_envir

[environment] The environment to use for scoping.

Details

This vignettes/_site.yml declares the default vignette rendering function for muggle vignettes. To enable it, you also must declare in the yaml frontmatter for each of the vignettes:

pkgdown:
 as_is: true

For an example of such a vignette with all its features, see vignette("vignette-muggle")

Features

Backported Bookdown Features

By default, pkgdown builds vignettes (or rather, articles) using a special format based on rmarkdown::html_document(). This format does not include the automatic numbering and crossreferencing of figures, tables, equations, and (for cross-references) sections supported by bookdown. The bookdown::html_document2() render function backports these features for uses outside of bookdown.

Raw HTML

Pandoc extensions are set to allow correctly indented raw HTML inside vignettes.

See Also

Other pkgdown functions: build_site2(), override_pkgdownyaml()

subugoe/muggle documentation built on Nov. 26, 2021, 11:42 p.m.