https://github.com/cran/pkgdown
Revision be39bf7826519337f2174410168506d8cd3cbe75 authored by Hadley Wickham on 30 November 2021, 20:10:03 UTC, committed by cran-robot on 30 November 2021, 20:10:03 UTC
1 parent 734352c
Tip revision: be39bf7826519337f2174410168506d8cd3cbe75 authored by Hadley Wickham on 30 November 2021, 20:10:03 UTC
version 2.0.0
version 2.0.0
Tip revision: be39bf7
build_favicons.Rd
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/build-favicons.R
\name{build_favicons}
\alias{build_favicons}
\alias{build_favicon}
\title{Create favicons from package logo}
\usage{
build_favicons(pkg = ".", overwrite = FALSE)
build_favicon(pkg, overwrite)
}
\arguments{
\item{pkg}{Path to package.}
\item{overwrite}{If \code{TRUE}, re-create favicons from package logo.}
}
\description{
This function auto-detects the location of your package logo (with the name
\code{logo.svg} (recommended format) or \code{logo.png}) and runs it through the
\url{https://realfavicongenerator.net} API to build a complete set of favicons
with different sizes, as needed for modern web usage.
}
\details{
You only need to run the function once. The favicon set will be stored in
\code{pkgdown/favicon} and copied by \code{\link[=init_site]{init_site()}} to the relevant location when
the website is rebuilt.
Once complete, you should add \verb{pkgdown/} to \code{.Rbuildignore } to avoid a NOTE
during package checking.
}
Computing file changes ...
