Function reference
All functions
-
build_site() - Build an altdown-themed altdoc website
-
use_altdown() - Set up a package to use altdown
Toy demo functions
Not part of the real package API. Injected during the site build for showcase.
build_site(
path = ".",
tooltips = requireNamespace("reftip", quietly = TRUE),
...
)Builds the package website into docs/ with altdoc::render_docs(), styled to mirror pkgdown.use_altdown(path = ".")Writes altdoc/altdown.yml, the one configuration file build_site() reads, with a starter reference: field listing every function currently documented in <path>/man/*.Rd in one "All functions"...greet(name = "world", loud = FALSE)A toy function that returns a greeting message.add(x, y)Add two numbers