Setup

If you haven’t started a pkgdown site yet, initialize it.

usethis::use_pkgdown()

In ./_pkgdown.yml add the contributed package:

template:
  package: pkgdownConfig

Point to this repository in DESCRIPTION to download the theme automatically.

Config/Needs/website: VisruthSK/pkgdownConfig

Now you should be good to run pkgdown::build_site()!

If for some reason the favicons don’t get copied over, download logo.svg, and run pkgdown::build_favicons() once to build the favicons. If you already have favicons,

Note that the favicons and logo should be copied into your build directory and ideally should be hooked in automatically. If you can’t find the logo, you can download it from here and follow the same steps above.

If you want the hex in your README, edit the README.MD. You can take a look at this package’s to get an idea of what you need to do (repeated below):

# pkgdownConfig <a href="https://visruthsk.github.io/pkgdownConfig"><img src="man/figures/logo.svg" align="right" height="139" alt="pkgdownConfig website" /></a>

For any further concerns/help/anything, open an issue and/or ping me on the Stan Slack.