Build a JSON file encompassing all HTML pages, for use by the search script.

build_search(pkg = ".", override = list())

Arguments

pkg

Path to package.

override

An optional named list used to temporarily override values in _pkgdown.yml

YAML config

You can exclude some paths from the search index. Below we exclude the changelog from the search index.

search:
  exclude: ['news/index.html']

Local testing

Search won't work if you simply use pkgdown preview of the static files. You can use servr::httw("docs") instead.