knitr::opts_knit$set(root.dir = rprojroot::find_rstudio_root_file()) # Set WD to Root here::i_am("dev/pkg-down.Rmd") library(here)
The GitHub page will be deployed from "gh-pages" branch of the package repo.
usethis::use_pkgdown_github_pages()
pkgdown::preview_site()
pkgdown::build_site()
pkgdown::build_home_index() pkgdown::init_site()
pkgdown::build_articles()
pkgdown::build_reference()
After commit changes to main branch, Github action (bot) will push necessary changes to "gh-pages" branch.
rstudioapi::navigateToFile("_pkgdown.yml")
# Template template: bootstrap: 5 bootswatch: flatly # Navigation Bar navbar: right: - icon: fa-github href: https://github.com/Lightbridge-KS/repo
# Function References reference: - title: Main Group of Functions: | These functions do what. contents: - '`fun_1`' - '`fun_2`'
To not list internal function, include @noRd
tags in Roxygen of the function.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.