init_site

This creates the output directory (<code>docs/</code>), a machine readable description
of the site, and copies CSS/JS assets and extra files.

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

RStudio 

init_site function

We recommend using <code><a rd-options="usethis:use_pkgdown" href="/link/usethis%3A%3Ause_pkgdown()?package=pkgdown&version=1.4.1&to=usethis%3Ause_pkgdown" data-mini-rdoc="usethis:use_pkgdown::usethis::use_pkgdown()">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

If you want to do minor customisation of your pkgdown site, the easiest
way is to add <code>pkgdown/extra.css</code> and <code>pkgdown/extra.js</code>. These
will be automatically copied to <code>docs/</code> and inserted into the
<code>&lt;HEAD&gt;</code> after the default pkgdown CSS and JS.

Custom CSS/JS

Favicons are built automatically from a logo PNG or SVG by <code><a rd-options="=init_site" href="/link/init_site()?package=pkgdown&version=1.4.1&to=%3Dinit_site" data-mini-rdoc="=init_site::init_site()">init_site()</a></code> and
copied to <code>pkgdown/favicon</code>.

Favicon

pkgdown creates a default 404 page (<code>404.html</code>). You can customize 404
page content using <code>.github/404.md</code>.

init_site: Initialise site infrastructure

Description

Usage

Arguments

Build-ignored files

Custom CSS/JS

Favicon

404