Skip to content

Commit

Permalink
Add mention of pkgdown_sitrep() in build_search() docs (#1771)
Browse files Browse the repository at this point in the history
  • Loading branch information
maelle authored Sep 20, 2021
1 parent aebaa72 commit 85d8beb
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 4 deletions.
9 changes: 7 additions & 2 deletions R/build-search-docs.R
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,15 @@ url_node <- function(url) {
#' search:
#' exclude: ['news/index.html']
#' ```
#' @section Local testing:
#' Search won't work if you simply use pkgdown preview of the static files.
#' @section Debugging and local testing:
#'
#' Locally (as opposed to on GitHub Pages or Netlify for instance),
#' search won't work if you simply use pkgdown preview of the static files.
#' You can use `servr::httw("docs")` instead.
#'
#' If search is not working, run `pkgdown::pkgdown_sitrep()` to eliminate
#' common issues such as the absence of URL in the pkgdown configuration file
#' of your package.
#'
#' @inheritParams build_articles
#' @export
Expand Down
10 changes: 8 additions & 2 deletions man/build_search.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 85d8beb

Please sign in to comment.