pkgdown: build_favicons – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

build_favicons

Create favicons from package logo

Description

This function auto-detects the location of your package logo (with the name logo.svg (recommended format) or logo.png) and runs it through the https://realfavicongenerator.net API to build a complete set of favicons with different sizes, as needed for modern web usage.

Usage

build_favicons(pkg = ".", overwrite = FALSE)

build_favicon(pkg, overwrite)

Arguments

`pkg`	Path to package.
`overwrite`	If `TRUE`, re-create favicons from package logo.

Details

You only need to run the function once. The favicon set will be stored in pkgdown/favicon and copied by init_site() to the relevant location when the website is rebuilt.

Once complete, you should add pkgdown/ to .Rbuildignore to avoid a NOTE during package checking.

pkgdown

Make Static HTML Documentation for a Package

v1.6.1

MIT + file LICENSE

Authors

Hadley Wickham [aut, cre] (<https://orcid.org/0000-0003-4757-117X>), Jay Hesselberth [aut] (<https://orcid.org/0000-0002-6299-179X>), RStudio [cph, fnd]

Initial release