First looks for
README.md. If none are found, falls back to the
description field in
build_home(pkg = ".", path = "docs", depth = 0L, encoding = "UTF-8")
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).
Output path. Relative paths are taken relative to the
Depth of path relative to root of documentation. Used to adjust relative links in the navbar.
The encoding of the input files.
To tweak the home page, you need a section called
The sidebar links are automatically generated by inspecting the
BugReports fields of the
You can add additional links with a subsection called
which should contain a list of
home: links: - text: Link text href: http://website.com
The "developers" list is populated by the maintainer ("cre"), authors ("aut"), and funder ("fnd").