rdcmtemplate

Overview

rdcmtemplate provides a custom pkgdown template for r-dcm packages. Please don’t use it for your own package.

This package and template were inspired by tidytemplate.

Templates

For all sites, ensure that DESCRIPTION contains:

Config/Needs/website: r-dcm/rdcmtemplate

r-dcm

template:
  package: rdcmtemplate
  bootstrap: 5
  
  includes:
    after_body: >
      <script data-goatcounter="https://{YOUR DOMAIN}.goatcounter.com/count" async src="https://gc.zgo.at/count.js"></script>
      
development:
  mode: auto

Ping Jake on teams to get your site added to goat counter.

Updating

If you’re updating from a previous pkgdown config, use the following checklist to make sure everything is up to date:

* [ ] `usethis::use_pkgdown_github_pages()`
* [ ] Ensure Author includes University of Kansas as copyright holder
* [ ] Update `DESCRIPTION` to include `Config/Needs/website: r-dcm/rdcmtemplate`
* [ ] Update `_pkgdown.yml` with appropriate template above.
* [ ] Ping Jake to add goat counter record
* [ ] Remove `strip_header: true`
* [ ] Remove algolia search, if used
* [ ] Eliminate superseded navbar customisation (`home: ~`, article re-ordering)
* [ ] Update `news` structure if needed
* [ ] Remove any author info for r-dcm folks (since now included in template)