Helpers for project setup with jdtdown — setup-helpers • jdtdown

These helper are mostly inspired by the one in usethis from the tidyverse team and are useful to setup a new pkgdown project with jdtdown

use_coc()

use_contributing()

use_readme_jdt()

use_jdtdown(config_file = "_pkgdown.yml", destdir = "docs")

use_gha_pkgdown()

Arguments

config_file: Path to the pkgdown yaml config file - could be set to be pkgdown/ subfolder.
destdir: Target directory for pkgdown docs. By default, it will be in docs sub directory for packages using jdtdown.

use_coc(): put _CODE\_OF\emphCONDUCT.md in .github/ directory setting the contact email to jdt's.
use_contributing(): Add a CONTRIBUTING.md file in .github/ following a template in jdtdown. Inspired by usethis::use_tidy_contributing().
use_readme_jdt(): Add a README.md file in the structure used by JDT's packages.
use_gha_pkgdown(): Add a GitHub Actions workflow for deploying the 'pkgdown' site and copy terminal code necessary to create an orphan 'gh-pages' branch.