build_favicons

This function auto-detects the location of your package logo (with the name
<code>logo.svg</code> (recommended format) or <code>logo.png</code>, created with <code><a href="https://usethis.r-lib.org/reference/use_logo.html">usethis::use_logo()</a></code>)
and runs it through the <a href="https://realfavicongenerator.net">https://realfavicongenerator.net</a> 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
<code>pkgdown/favicon</code> and copied by <code>init_site()</code> to the relevant location when
the website is rebuilt.
Once complete, you should add <code>pkgdown/</code> to <code>.Rbuildignore </code> to avoid a NOTE
during package checking. (<code><a href="https://usethis.r-lib.org/reference/use_logo.html">usethis::use_logo()</a></code> does this for you!)

Generate an attractive and useful website from a source
package.  'pkgdown' converts your documentation, vignettes, 'README',
and more to 'HTML' making it easy to share information about your
package online.

Hadley Wickham

pkgdown

Make Static HTML Documentation for a Package

Jay Hesselberth

Maëlle Salmon

Olivier Roy

Salim Brüggemann

Posit Software, PBC 

build_favicons function

<dl><dt>pkg</dt>
<dd>Path to package.</dd>
<dt>overwrite</dt>
<dd>If <code>TRUE</code>, re-create favicons from package logo.</dd></dl>

Arguments

This function auto-detects the location of your package logo (with the name
<code>logo.svg</code> (recommended format) or <code>logo.png</code>, created with <code><a href='https://usethis.r-lib.org/reference/use_logo.html'>usethis::use_logo()</a></code>)
and runs it through the <a href='https://realfavicongenerator.net'>https://realfavicongenerator.net</a> 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
<code>pkgdown/favicon</code> and copied by <code>init_site()</code> to the relevant location when
the website is rebuilt.
Once complete, you should add <code>pkgdown/</code> to <code>.Rbuildignore </code> to avoid a NOTE
during package checking. (<code><a href='https://usethis.r-lib.org/reference/use_logo.html'>usethis::use_logo()</a></code> does this for you!)

Initialise favicons from package logo — build_favicons

<dl>

<dt>pkg</dt>
<dd>Path to package.</dd>


<dt>overwrite</dt>
<dd>If <code>TRUE</code>, re-create favicons from package logo.</dd>

</dl>

build_favicons: Initialise favicons from package logo

Description

Usage

Arguments