R/check.R

Defines functions check_pkgdown

Documented in check_pkgdown

#' Check `_pkgdown.yml`
#'
#' Check that your `_pkgdown.yml` is valid without building the whole
#' site.
#'
#' @export
#' @inheritParams as_pkgdown
check_pkgdown <- function(pkg = ".") {
  pkg <- as_pkgdown(pkg)

  data_open_graph(pkg)
  data_articles_index(pkg)
  data_reference_index(pkg)

  inform("No problems found")
}

Try the pkgdown package in your browser

Any scripts or data that you put into this service are public.

pkgdown documentation built on Dec. 28, 2022, 1:37 a.m.