Skip to contents

gitdevr

Overview

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

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

Installation

You can install the development version of gitdevr by running:

pak::pak("dieghernan/gitdevr")

Alternatively, you can install gitdevr from r-universe:

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

Usage

After installing gitdevr, add the following template settings to your _pkgdown.yml file. Then build your site with pkgdown::build_site().

_pkgdown.yml
template:
  bootstrap: 5
  package: gitdevr
Important

Do not use default_assets: false with this template. gitdevr relies on pkgdown assets and templates.

We recommend adding 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.