Skip to content
pkgdown template for rOpenSci packages 💅
HTML CSS R
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
R
inst
man
pkgdown/favicon
vignettes
.Rbuildignore
.gitignore
.travis.yml
DESCRIPTION
LICENSE
LICENSE.md
NAMESPACE
NEWS.md
README.Rmd
README.md
_pkgdown.yml
rotemplate.Rproj

README.md

rotemplate

Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. Build Status

rotemplate provides a custom pkgdown template for rOpenSci packages. We use this to render sites at https://docs.ropensci.org. Please don’t use it for your own package if it’s not an rOpenSci package (i.e. only use it for packages listed on https://ropensci.org/packages/).

Inspired by tidytemplate and lockedatapkg.

How to use rotemplate

Documentation rOpenSci packages will automatically be generated from your master branch and published to https://docs.ropensci.org. You don’t have to do anything to make this work. If you want to test your site locally use this:

template <- list(package = "rotemplate")
pkgdown::build_site(devel = FALSE, override = list(template = template))

Everything else can be configured as usual via the _pkgdown.yml file as described in the pkgdown documentation.

If your website is not deploying or you run into another problem, please open an issue in the ropensci/docs repository.

Example sites

You can’t perform that action at this time.