This is a small README for the rags2ridges documentation website created by the pkgdown-package.
The _pkgdown.yml
file primarily controls how the site is build.
Learn more at: https://pkgdown.r-lib.org/
To build the site run:
install.packages("pkgdown")
pkgdown::build_site()
Individual sections of the site can be build in a similar manner.
After successfully building, a /docs
folder containing the generated website will appear. These are local files only and should be committed.
Travis-CI will be responsible for building (generating /docs
)and pushing it to a specific git(hub) branch. When build, GitHub hosts the site and exposes it to the internet (via 'GitHub pages').
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.