1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/vignette.R
\name{use_vignette}
\alias{use_vignette}
\alias{use_article}
\title{Create a vignette or article}
\usage{
use_vignette(name, title = NULL)
use_article(name, title = NULL)
}
\arguments{
\item{name}{File name to use for new vignette. Should consist only of
numbers, letters, \verb{_} and \code{-}. Lower case is recommended. Can include the
\code{".Rmd"} or \code{".qmd"} file extension, which also dictates whether to place
an R Markdown or Quarto vignette. R Markdown (\code{".Rmd"}) is the current
default, but it is anticipated that Quarto (\code{".qmd"}) will become the
default in the future.}
\item{title}{The title of the vignette. If not provided, a title is generated
from \code{name}.}
}
\description{
Creates a new vignette or article in \verb{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 \code{.Rbuildignore}
automatically).
}
\section{General setup}{
\itemize{
\item Adds needed packages to \code{DESCRIPTION}.
\item Adds \code{inst/doc} to \code{.gitignore} so built vignettes aren't tracked.
\item Adds \verb{vignettes/*.html} and \verb{vignettes/*.R} to \code{.gitignore} so
you never accidentally track rendered vignettes.
\item For \verb{*.qmd}, adds Quarto-related patterns to \code{.gitignore} and
\code{.Rbuildignore}.
}
}
\examples{
\dontrun{
use_vignette("how-to-do-stuff", "How to do stuff")
use_vignette("r-markdown-is-classic.Rmd", "R Markdown is classic")
use_vignette("quarto-is-cool.qmd", "Quarto is cool")
}
}
\seealso{
\itemize{
\item The \href{https://r-pkgs.org/vignettes.html}{vignettes chapter} of
\href{https://r-pkgs.org}{R Packages}
\item The pkgdown vignette on Quarto:
\code{vignette("quarto", package = "pkgdown")}
\item The quarto (as in the R package) vignette on HTML vignettes:
\code{vignette("hello", package = "quarto")}
}
}
|
