Package index

Package overview

Learn about pkgdev and find related helpers.

pkgdev pkgdev-package

pkgdev: Helpers to Develop Packages with GitHub Actions

Package maintenance helpers

Run the maintenance workflow with update_docs() and manage ignore files with add_global_gitgnore().

add_global_gitgnore()

Add a global .gitignore file to a package

update_docs()

Document your package

Documentation rendering helpers

Render Quarto documents and README files, or precompute R Markdown and Quarto vignettes.

build_qmd() build_readme_qmd()

Build Quarto files for a package

precompute_vignette() precompute_vignette_all()

Precompute vignettes

Documentation checking helpers

Check generated Rd titles for sentence case and trailing periods.

check_rd_titles()

Inspect Rd file titles

GitHub Actions workflow helpers

Create workflows to check packages, update documentation and deploy pkgdown sites.

gha_check_full()

Create a GitHub Actions workflow that checks your package regularly

gha_pkgdown_branch()

Create a GitHub Actions workflow that builds a pkgdown site

gha_update_docs()

Create a GitHub Actions workflow that documents and checks your package