# Author: Kevin See
# Purpose: Build a website for this package using pkgdown
# Created: 5/17/2021
# Last Modified: 5/17/2021
# Notes: Based on instructions found here: https://pkgdown.r-lib.org/index.html
#-----------------------------------------------------------------
# load needed libraries
library(pkgdown)
#-----------------------------------------------------------------
# set up to automatically publish pkgdown site to GitHub
usethis::use_pkgdown_github_pages()
#-----------------------------------------------------------------
# Run once to configure your package to use pkgdown
usethis::use_pkgdown()
# check that _pkgdown.yml looks good
pkgdown::check_pkgdown()
# Run to build the website
pkgdown::build_site()
# Hadley Wickham suggested running this if there are errors, to get a traceback in the current process
pkgdown::build_site(new_process = FALSE)
# to look at the site
pkgdown::preview_site()
#-----------------------------------------------------------------
# deploy site to gh-pages branch on GitHub
pkgdown::deploy_to_branch()
# configures a GitHub Action to automatically build the pkgdown site and deploy it via GitHub Pages
usethis::use_github_action("pkgdown")
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.