State- and University Library of Göttingen pkgdown template

pkgdown_template()

Value

named list of paths to assets and templates for web design

Pkgdown Usage

To use this template for your pkgdown website, list subugoetheme in your DESCRIPTION and add to your _pkgdown.yml:

template:
  package: subugoetheme

To update your website, install the current version of subugoetheme and re-run pkgdown::build_site() locally or in your CI.

Features:

As a result, your website will:

Use the bootswatch cosmo bootstrap theme with an inverse navbar. The corresponding settings in you _pkgdown.yml (template: params: bootswatch, navbar: type: inverse) are ignored.
Display in a University of Göttingen color scheme. This is determined by the ugoe_bootswatch.css, which is compiled from ugoe_colors.less. The colors were added and downloaded via https://www.bootstrap-live-customizer.com.
Include the SUB wordmark in your website as sub_wordmark.jpg. The wordmark is included in the custom footer.
Expose the SUB twitter account @subugoe as opengraph metadata (twitter: site).
Link to the SUB legal boilerplate.

For additional features, see muggle.

Analytics:

Instead of Google Analytics, this template includes a tracking code for matomo.gwdg.de on every website. Matomo is an open-source alternative to Google Analytics, here hosted by the GWDG.

To opt out, users are directed to the matomo opt-out at sub.uni-goettingen.de. The gwdg matomo instance respects the opt-out set on sub.uni-goettingen.de.

The following SUB employees have access to the analytics:

Maintenance:

To pull in upstream changes from pkgdown into this package, it may be ocassionally neccessary to update the files in inst/pkgdown/templates which have been minimally adapted from their original counterparts in pkgdown.

To learn more about pkgdown templates, read here or consider these examples.

Other Usage

The CSS targets bootstrap 3.x and can thus be used on other bootstrap 3.x websites.

flexdashboard

To use the CSS for flexdasboard, list subugoetheme in your DESCRIPTION and add to your yaml frontmatter:

output:
 flexdashboard::flex_dashboard:
   css: !expr subugoetheme::pkgdown_template()$assets$css