check_pkgdown

pkgdown_sitrep

This pair of functions checks that your <code>_pkgdown.yml</code> is valid without
building the whole site. <code>check_pkgdown()</code> errors at the first problem;
<code>pkgdown_sitrep()</code> reports the status of all checks.
Currently they check that:<ul>
<li>There's a <code>url</code> in the pkgdown configuration, which is also recorded
in the <code>URL</code> field of the <code>DESCRIPTION</code>.</li>
<li>All opengraph metadata is valid.</li>
<li>All reference topics are included in the index.</li>
<li>All articles/vignettes are included in the index.</li>
</ul>

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 

check_pkgdown function

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

Arguments

Check _pkgdown.yml — check_pkgdown

<dl>

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

</dl>

check_pkgdown: Check `_pkgdown.yml`

Description

Usage

Arguments