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/).
How to use
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:
library(rotemplate) #install.packages("yourpkg") rotemplate::build_ropensci_docs("path/to/yourpkg")
Everything else can be configured as usual via the
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.
if you want to use Mathjax you’ll need to specify it in the
config file like so:
template: params: mathjax: true