Creates a new vignette or article in vignettes/
. Articles are a special
type of vignette that appear on pkgdown websites, but are not included
in the package itself (because they are added to .Rbuildignore
automatically).
Arguments
- name
File name to use for new vignette. Should consist only of numbers, letters,
_
and-
. Lower case is recommended. Can include the".Rmd"
or".qmd"
file extension, which also dictates whether to place an R Markdown or Quarto vignette. R Markdown (".Rmd"
) is the current default, but it is anticipated that Quarto (".qmd"
) will become the default in the future.- title
The title of the vignette. If not provided, a title is generated from
name
.
General setup
Adds needed packages to
DESCRIPTION
.Adds
inst/doc
to.gitignore
so built vignettes aren't tracked.Adds
vignettes/*.html
andvignettes/*.R
to.gitignore
so you never accidentally track rendered vignettes.For
*.qmd
, adds Quarto-related patterns to.gitignore
and.Rbuildignore
.
See also
The vignettes chapter of R Packages
The pkgdown vignette on Quarto:
vignette("quarto", package = "pkgdown")
The quarto (as in the R package) vignette on HTML vignettes:
vignette("hello", package = "quarto")