Function Reference

as_markdown.tag_code_link_pkgdocs

Handle code reference links

as_markdown.tag_link_pkgdocs

Handle reference links

as_markdown.tag_pkgdocs

Handle misc. if needed

build

Build Package Documentation

build_config_yaml

copies config.yaml template and adds YAML keys

build_home

Build Package Documentation Homepage

build_hugo_front_matter

Build Hugo Front Matter

build_index_page

Adds the YAML section to the reference .Rd file

build_license

Build Package License page from LICENSE and LICENSE.md

build_metadata

Build a metadata YAML file.

build_module

Build A Package Documentation Module

build_news

Build Package Documentation Changelog

build_references

Build Package Documentation from README.md

build_vignettes

Build the articles section from vignettes

find_repo_root

Find a git repository root under a given local path

find_source_package_root

Find an R source package under a given local path

hugo_available

Check if Hugo is available

hugo_page

Convert to a Hugo markdown page document

hugo_publish

Publish a Hugo site

hugo_server

Run a Hugo development server

init

Initialize pkgdocs documentation

write_hugo_compose_file

Write a compose file to run Hugo development server dockerized