Skip to content

greta-dev/greta.pkgdown

Repository files navigation

greta.pkgdown

pkgdown

greta.pkgdown is the shared Bootstrap 5 pkgdown template for the greta family of packages. It gives every greta package a consistent look and feel: the greta purple theme, Roboto typography, tinted code blocks, and the greta wordmark in the navbar.

This is an internal template for the greta family of packages. Please don't depend on it for your own package.

How to use

In a greta package, add the template to _pkgdown.yml:

template:
  package: greta.pkgdown
  bootstrap: 5

and add greta.pkgdown to the website dependencies in DESCRIPTION so it is installed when the site is built:

Config/Needs/website: greta-dev/greta.pkgdown

The shared theme, navbar wordmark, and SCSS are then applied automatically. Each package keeps full control of its own navbar left: structure, reference index, articles, and home page.

What's shared

  • Theme — bslib variables for the greta purple (#A379CC), a tinted code background, and Roboto / Roboto Mono fonts.
  • Navbar wordmark — a templates/navbar.html override that swaps the package-name text for the greta wordmark image. A package can override the image by shipping its own name_icon_on_white.png.
  • SCSS — navbar and code styling plus opt-in scaffolding for a full-width greta-style home page.

Favicons, the reference index, articles, and home-page content stay per-package.

Structure

The template follows the standard pkgdown template-package layout (as used by tidyverse/tidytemplate):

inst/pkgdown/BS5/
├── _pkgdown.yml          # shared template: theme + navbar defaults
├── extra.scss            # shared SCSS
├── assets/
│   └── name_icon_on_white.png   # default navbar wordmark
└── templates/
    └── navbar.html       # wordmark-in-navbar override

About

A pkgdown template for greta packages / extensions

Resources

License

Unknown, MIT licenses found

Licenses found

Unknown
LICENSE
MIT
LICENSE.md

Stars

2 stars

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors