build_home | R Documentation |
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
.
build_home(pkg = ".", path = "docs", depth = 0L, encoding = "UTF-8")
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
|
depth |
Depth of path relative to root of documentation. Used to adjust relative links in the navbar. |
encoding |
The encoding of the input files. |
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").
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.