diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml index bfc9f4d..bd1631b 100644 --- a/.github/workflows/pkgdown.yaml +++ b/.github/workflows/pkgdown.yaml @@ -33,7 +33,7 @@ jobs: - uses: r-lib/actions/setup-r-dependencies@v2 with: - extra-packages: any::pkgdown, local::. + extra-packages: any::pkgdown, any::brand.yml, local::. needs: website - name: Build site diff --git a/.github/workflows/sync-foresite-brand.yml b/.github/workflows/sync-foresite-brand.yml new file mode 100644 index 0000000..bf9aa9a --- /dev/null +++ b/.github/workflows/sync-foresite-brand.yml @@ -0,0 +1,16 @@ +name: Sync ForeSITE brand + +on: + schedule: + - cron: "17 5 * * 1" + workflow_dispatch: + +permissions: + contents: write + pull-requests: write + +jobs: + sync: + uses: EpiForeSITE/rbranding/.github/workflows/sync-foresite-brand.yml@main + with: + source-ref: main diff --git a/DESCRIPTION b/DESCRIPTION index cbe6a73..f3cb7f4 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -44,6 +44,7 @@ Suggests: stringr, purrr Config/testthat/edition: 3 +Config/Needs/website: brand.yml VignetteBuilder: knitr Roxygen: list(markdown = TRUE) URL: https://epiforesite.github.io/multigroup-vaccine/ diff --git a/NEWS.md b/NEWS.md index 4345568..489ad14 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,7 @@ +# multigroup.vaccine (development version) + +* Added the ForeSITE pkgdown brand and weekly brand-sync workflow. + # multigroup.vaccine 0.1.1 * Initial release on CRAN diff --git a/_pkgdown.yml b/_pkgdown.yml index 67722b1..3227d3e 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -1,6 +1,25 @@ url: https://epiforesite.github.io/multigroup-vaccine template: bootstrap: 5 + light-switch: false + bslib: + brand: pkgdown/brand/_brand.yml + +navbar: + bg: light + +footer: + structure: + left: [developed_by, foresite] + right: built_with + components: + foresite: >- + Part of the [ForeSITE](https://github.com/EpiForeSITE) software + ecosystem. This project was made possible by cooperative agreement + CDC-RFA-FT-23-0069 from the CDC's Center for Forecasting and Outbreak + Analytics. Its contents are solely the responsibility of the authors and do + not necessarily represent the official views of the Centers for Disease + Control and Prevention. authors: "Damon Toth": diff --git a/pkgdown/brand/_brand.yml b/pkgdown/brand/_brand.yml new file mode 100644 index 0000000..594f5af --- /dev/null +++ b/pkgdown/brand/_brand.yml @@ -0,0 +1,97 @@ +# ForeSITE brand (https://posit-dev.github.io/brand-yml/) +# +# Source: "ForeSITE Usage Guidelines" (WSU Design and Printing Services, +# N12526.4.24). Check details in the ForeSITE shared folders. +# +# Official logo colors (do not alter): +# Crimson #A60F2D PMS 201 C +# Gold #FDB921 PMS 1235 C +# Dark Gray #4E4E4E PMS 7540 C (RGB 78, 78, 78; the guide's "9A5107" hex is a typo) +# +# WCAG 2.1 contrast (on white #FFFFFF): +# crimson 7.70:1 (AA/AAA) | dark-gray 8.32:1 (AA/AAA) | gold 1.73:1 (FAIL) +# => gold is an accent/fill color only; never use it for text on light +# backgrounds. Dark gray (4.81:1) or black text is fine on gold. + +meta: + name: + short: ForeSITE + full: ForeSITE + link: + home: https://github.com/EpiForeSITE + github: https://github.com/EpiForeSITE + +logo: + images: + # `icon` and `full` are the names used by rbranding::brand_add_logo() + icon: + path: assets/logos/foresite-icon.png + alt: "ForeSITE logo" + full: + path: assets/logos/foresite-primary.png + alt: "ForeSITE logo" + full-white: + path: assets/logos/foresite-white.png + alt: "ForeSITE logo" + secondary: + path: assets/logos/foresite-secondary.png + alt: "ForeSITE logo" + # Use `full-white` on dark backgrounds (see guidelines, p. 3) + small: icon + medium: full + large: full + +color: + palette: + crimson: "#A60F2D" + gold: "#FDB921" + dark-gray: "#4E4E4E" + # Supporting neutrals (not part of the logo guidelines) + white: "#FFFFFF" + light-gray: "#F5F5F5" + black: "#000000" + foreground: dark-gray + background: white + primary: crimson + secondary: dark-gray + tertiary: gold + warning: gold + light: light-gray + dark: dark-gray + +typography: + # The logo type is Proxima Nova Semibold (a commercial font). Montserrat is + # the closest freely available geometric sans and is used for headings. + fonts: + - family: Montserrat + source: google + weight: [400, 600, 700] + - family: Open Sans + source: google + weight: [400, 600, 700] + style: [normal, italic] + - family: IBM Plex Mono + source: google + weight: [400, 600] + base: + family: Open Sans + line-height: 1.6 + headings: + family: Montserrat + weight: 600 + color: dark-gray + link: + color: crimson + decoration: underline + monospace: + family: IBM Plex Mono + size: 0.9em + +defaults: + bootstrap: + rules: | + .navbar { border-bottom: 4px solid $brand-gold; } + h1, .h1 { color: $brand-crimson; } + a:hover, a:focus { color: darken($brand-crimson, 10%); } + :focus-visible { outline: 3px solid $brand-gold; outline-offset: 2px; } + blockquote { border-left: 4px solid $brand-gold; } diff --git a/pkgdown/brand/assets/logos/foresite-black.png b/pkgdown/brand/assets/logos/foresite-black.png new file mode 100644 index 0000000..d29be0a Binary files /dev/null and b/pkgdown/brand/assets/logos/foresite-black.png differ diff --git a/pkgdown/brand/assets/logos/foresite-crimson.png b/pkgdown/brand/assets/logos/foresite-crimson.png new file mode 100644 index 0000000..3ee29c8 Binary files /dev/null and b/pkgdown/brand/assets/logos/foresite-crimson.png differ diff --git a/pkgdown/brand/assets/logos/foresite-gold.png b/pkgdown/brand/assets/logos/foresite-gold.png new file mode 100644 index 0000000..d90283a Binary files /dev/null and b/pkgdown/brand/assets/logos/foresite-gold.png differ diff --git a/pkgdown/brand/assets/logos/foresite-icon.png b/pkgdown/brand/assets/logos/foresite-icon.png new file mode 100644 index 0000000..1bed9cd Binary files /dev/null and b/pkgdown/brand/assets/logos/foresite-icon.png differ diff --git a/pkgdown/brand/assets/logos/foresite-primary.png b/pkgdown/brand/assets/logos/foresite-primary.png new file mode 100644 index 0000000..27035d4 Binary files /dev/null and b/pkgdown/brand/assets/logos/foresite-primary.png differ diff --git a/pkgdown/brand/assets/logos/foresite-secondary.png b/pkgdown/brand/assets/logos/foresite-secondary.png new file mode 100644 index 0000000..561e1c3 Binary files /dev/null and b/pkgdown/brand/assets/logos/foresite-secondary.png differ diff --git a/pkgdown/brand/assets/logos/foresite-white.png b/pkgdown/brand/assets/logos/foresite-white.png new file mode 100644 index 0000000..8bb369e Binary files /dev/null and b/pkgdown/brand/assets/logos/foresite-white.png differ