build_home: Build home page

In Laurae2/pkgdown: Make Static HTML Documentation for a Package

Description

First looks for index.Rmd or README.Rmd, then index.md or README.md. If none are found, falls back to the description field in DESCRIPTION.

Usage

build_home(pkg = ".", path = "docs", depth = 0L, encoding = "UTF-8")

Arguments

pkg	Path to source package. If R working directory is not set to the source directory, then pkg must be a fully qualified path to the source directory (not a relative path).
path	Output path. Relative paths are taken relative to the pkg directory.
depth	Depth of path relative to root of documentation. Used to adjust relative links in the navbar.
encoding	The encoding of the input files.

YAML config

To tweak the home page, you need a section called home.

The sidebar links are automatically generated by inspecting the URL and BugReports fields of the DESCRIPTION. You can add additional links with a subsection called links, which should contain a list of text + href elements:

home:
  links:
  - text: Link text
    href: http://website.com

The "developers" list is populated by the maintainer ("cre"), authors ("aut"), and funder ("fnd").

Laurae2/pkgdown documentation built on May 27, 2019, 12:17 p.m.