autolink_html: Automatic link references and articles in an HTML package

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

Description

The autolinker is built around two XPath expressions:

• //pre[contains(@class, 'r')]: this finds all <div>s with class sourceCode and r. The contents must be syntax-highlighted using pygments. (This is default in rmarkdown::html_document when theme = NULL.)

• .//code[count(*) = 0]: this finds all <code> that contain only text (and no other tags).

Usage

autolink_html(input, output = input, local_packages = character())

Arguments

input, output	Input and output paths for HTML file
local_packages	A named character vector providing relative paths (value) to packages (name) that can be reached with relative links from the target HTML document.

Details

Currently the following expressions are linked:

• Function calls, foo()

• Function calls qualified with the package name, bar::foo()

• Symbols qualified with the package name, bar::baz

• Help calls, ?foo, package?foo, and ?bar::foo

• Vignette calls, vignette(baz), vignette(baz, package = "bar")

Calls to library() and require() are used to find the topics connected to unqualified references.

Examples

## Not run: 
autolink_html("path/to/file.html",
  local_packages = c(
    shiny = "shiny",
    shinydashboard = "shinydashboard"
  )
)

## End(Not run)

jayhesselberth/pkgdown-search documentation built on May 17, 2019, 9:12 a.m.