build_favicons: Initialise favicons from package logo
In pkgdown: Make Static HTML Documentation for a Package
View source: R/build-favicons.R
build_favicons R Documentation
Initialise 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, created with usethis::use_logo())
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.
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. (usethis::use_logo() does this for you!)
Usage
build_favicons(pkg = ".", overwrite = FALSE)
Arguments
pkg
Path to package.
overwrite
If TRUE, re-create favicons from package logo.
pkgdown documentation built on Sept. 18, 2024, 1:06 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
View source: R/build-favicons.R
| build_favicons | R Documentation |
Initialise 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, created with usethis::use_logo())
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.
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. (usethis::use_logo() does this for you!)
Usage
build_favicons(pkg = ".", overwrite = FALSE)
Arguments
pkg |
Path to package. |
overwrite |
If |
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.