check_pkgdown: Check _pkgdown.yml
In pkgdown: Make Static HTML Documentation for a Package
check_pkgdown R Documentation
Check _pkgdown.yml
Description
This pair of functions checks that your _pkgdown.yml is valid without
building the whole site. check_pkgdown() errors at the first problem;
pkgdown_sitrep() reports the status of all checks.
Currently they check that:
There's a url in the pkgdown configuration, which is also recorded
in the URL field of the DESCRIPTION.
All opengraph metadata is valid.
All reference topics are included in the index.
All articles/vignettes are included in the index.
Usage
check_pkgdown(pkg = ".")
pkgdown_sitrep(pkg = ".")
Arguments
pkg
Path to package.
pkgdown documentation built on June 8, 2025, 10:05 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.
| check_pkgdown | R Documentation |
Check _pkgdown.yml
Description
This pair of functions checks that your _pkgdown.yml is valid without
building the whole site. check_pkgdown() errors at the first problem;
pkgdown_sitrep() reports the status of all checks.
Currently they check that:
There's a
urlin the pkgdown configuration, which is also recorded in theURLfield of theDESCRIPTION.All opengraph metadata is valid.
All reference topics are included in the index.
All articles/vignettes are included in the index.
Usage
check_pkgdown(pkg = ".")
pkgdown_sitrep(pkg = ".")
Arguments
pkg |
Path to package. |
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.