My pkgdown template • gitdevr

Overview

gitdevr provides a custom pkgdown template based on the GitDev skin provided with my Jekyll theme chulapa.

See a preview of the template at https://dieghernan.github.io/gitdevr/.

Installation

You can install the development version of gitdevr with:

pak::pak("dieghernan/gitdevr")

Alternatively, you can install gitdevr using the r-universe:

# Install gitdevr in R:
install.packages(
  "gitdevr",
  repos = c(
    "https://dieghernan.r-universe.dev",
    "https://cloud.r-project.org"
  )
)

Usage

After installation, if your pkgdown setup is ready, specify the template parameter as follows. Then, as before, build your site with pkgdown::build_site().

.pkgdown.yaml

template:
  bootstrap: 5
  package: gitdevr

Important

Keep in mind that you should not use default_assets: false when you change the default template. gitdevr relies on some of the pkgdown assets and templates.

It is recommended to add the following line to your DESCRIPTION:

DESCRIPTION

Config/Needs/website: dieghernan/gitdevr

When you use r-lib actions to deploy your site, GitHub Actions installs the package automatically.