geco-bern / geco_documentation_template

Documentation template for R package websites

GECO pkgdown template

GECO_template provides a custom pkgdown template for GECO packages. Please don’t use it for your own package. This theme was inspired by inspired by tidytemplate, rotemplate and bgtemplate

- NOTE: Do not use this package as a package template, this is for documentation only!
- Use the proper R project template!

How to use GECO_template

Install the template as an R package

devtools::install_github("geco-bern/GECO_documentation_template")

Set the package template as the override template to use when rendering a package documentation using pkgdown

template <- list(package = "gecotemplate")
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.

Alternatively, set the template in _pkgdown.yml.

template:
  package: gecotemplate

Mathjax

if you want to use Mathjax you’ll need to specify it in the pkgdown config file like so:

template:
  params:
    mathjax: true