R/build-search-docs.R

In jayhesselberth/pkgdown-search: Make Static HTML Documentation for a Package

#' @importFrom jsonlite write_json
build_docsearch_json <- function(pkg = ".") {
  pkg <- as_pkgdown(pkg)

  index_name <- pkg$meta$template$params$docsearch$index_name
  if (is.null(index_name)) {
    return()
  }

  data <- list(
    "index_name" = index_name,
    "start_urls" = list(pkg$meta$url),
    "stop_urls" = c("index.html", "authors.html", "/LICENSE", "/news/"),
    "sitemap_urls" = list(paste0(pkg$meta$url, "/", "sitemap.xml")),
    "selectors" = list(
      "lvl0" = ".contents h1",
      "lvl1" = ".contents .name",
      "lvl2" = ".contents h2",
      "lvl3" = ".contents h3, .contents th",
      "lvl4" = ".contents h4",
      "text" = ".contents p, .contents li, .usage, .template-article .contents .pre"
    ),
    "selectors_exclude" = list(".dont-index")
  )

  json_path <- path(pkg$dst_path, "docsearch.json")
  cat_line("Writing ", dst_path(path_rel(json_path, pkg$dst_path)))

  jsonlite::write_json(
    data,
    json_path,
    pretty = TRUE,
    auto_unbox = TRUE
  )

  invisible()
}

build_sitemap <- function(pkg = ".") {
  pkg <- as_pkgdown(pkg)

  url <- pkg$meta$url
  if (is.null(url)) {
    return()
  }

  urls <- paste0(
    url, "/",
    c(
      path("reference", unique(pkg$topics$file_out)),
      path(pkg$vignettes$file_out)
    )
  )

  doc <- xml2::read_xml(
    paste0("<urlset xmlns = 'http://www.sitemaps.org/schemas/sitemap/0.9'></urlset>")
  )

  url_nodes <- purrr::map(urls, url_node)
  for (url in url_nodes) {
    xml2::xml_add_child(doc, url)
  }

  xml_path <- path(pkg$dst_path, "sitemap.xml")
  cat_line("Writing ", dst_path(path_rel(xml_path, pkg$dst_path)))

  xml2::write_xml(doc, file = xml_path)

  invisible()
}

url_node <- function(url) {
  xml2::read_xml(
    paste0("<url><loc>", url, "</loc></url>")
  )
}