init_site

<code>init_site()</code>:<ul>
<li>creates the output directory (<code>docs/</code>),</li>
<li>generates a machine readable description of the site, used for autolinking,</li>
<li>copies CSS/JS assets and extra files, and</li>
<li>runs <code>build_favicons()</code>, if needed.</li>
</ul>See <code>vignette("customise")</code> for the various ways you can customise the
display of your site.

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

Posit Software, PBC 

init_site function

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

Arguments

We recommend using <code><a href="https://usethis.r-lib.org/reference/use_pkgdown.html">usethis::use_pkgdown()</a></code> to build-ignore <code>docs/</code> and
<code>_pkgdown.yml</code>. If use another directory, or create the site manually,
you'll need to add them to <code>.Rbuildignore</code> yourself. A <code>NOTE</code> about
an unexpected file during <code>R CMD CHECK</code> is an indication you have not
correctly ignored these files.

Build-ignored files

<code>init_site()</code>:<ul>
<li>creates the output directory (<code>docs/</code>),</li>
<li>generates a machine readable description of the site, used for autolinking,</li>
<li>copies CSS/JS assets and extra files, and</li>
<li>runs <code>build_favicons()</code>, if needed.</li>
</ul>

See <code>vignette("customise")</code> for the various ways you can customise the
display of your site.

Initialise site infrastructure — init_site

<dl>

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

</dl>

We recommend using <code><a href='https://usethis.r-lib.org/reference/use_pkgdown.html'>usethis::use_pkgdown()</a></code> to build-ignore <code>docs/</code> and
<code>_pkgdown.yml</code>. If use another directory, or create the site manually,
you'll need to add them to <code>.Rbuildignore</code> yourself. A <code>NOTE</code> about
an unexpected file during <code>R CMD CHECK</code> is an indication you have not
correctly ignored these files.

init_site: Initialise site infrastructure

Description

Usage

Arguments

Build-ignored files