autolink_html: Automatic link references and articles in an HTML package

Description Usage Arguments Details Examples

Description

The autolinker is built around two XPath expressions:

Usage

1
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:

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

Examples

1
2
3
4
5
6
7
8
9
## Not run: 
autolink_html("path/to/file.html",
  local_packages = c(
    shiny = "shiny",
    shinydashboard = "shinydashboard"
  )
)

## End(Not run)

aaronrudkin/pkgdown documentation built on May 23, 2019, 4:23 p.m.