In Lightbridge-KS/labChartHRV: LabChart's HRV Data Import and Manipulation

knitr::opts_knit$set(root.dir = rprojroot::find_rstudio_root_file()) # Set WD to Root
here::i_am("dev/pkg-down.Rmd")
library(here)

Setup GitHub Pages

The GitHub page will be deployed from "gh-pages" branch of the package repo.

usethis::use_pkgdown_github_pages()

Preview Site

pkgdown::preview_site()

Build Site

Build Whole Site (Wrapper)

pkgdown::build_site()

Build Home Quickly

pkgdown::build_home_index()  
pkgdown::init_site()

Build Ref

pkgdown::build_reference()

Build Articles

renders each R Markdown file underneath vignettes/ and saves it to articles/

pkgdown::build_articles()

After commit changes to main branch, Github action (bot) will push necessary changes to "gh-pages" branch.

Customize Pages

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.

Lightbridge-KS/labChartHRV documentation built on June 12, 2022, 3:21 p.m.