View source: R/macro-pkgdown.R
do_pkgdown | R Documentation |
do_pkgdown()
builds and optionally deploys a pkgdown site and adds default
steps to the "install"
, "before_deploy"
and "deploy"
stages:
step_install_deps()
in the "install"
stage
step_session_info()
in the "install"
stage.
step_setup_ssh()
in the "before_deploy"
to setup
the upcoming deployment (if deploy
is set and only on
GitHub Actions),
step_setup_push_deploy()
in the "before_deploy"
stage
(if deploy
is set),
step_build_pkgdown()
in the "deploy"
stage,
forwarding all ...
arguments.
step_do_push_deploy()
in the "deploy"
stage.
By default, the docs/
directory is deployed to the gh-pages
branch,
keeping the history.
do_pkgdown(
...,
deploy = NULL,
orphan = FALSE,
checkout = TRUE,
path = "docs",
branch = "gh-pages",
remote_url = NULL,
commit_message = NULL,
commit_paths = ".",
force = FALSE,
private_key_name = "TIC_DEPLOY_KEY"
)
... |
Passed on to |
deploy |
|
orphan |
|
checkout |
|
path, branch |
By default, this macro deploys the |
remote_url |
|
commit_message |
|
commit_paths |
|
force |
|
private_key_name |
|
Other macros:
do_blogdown()
,
do_bookdown()
,
do_drat()
,
do_package_checks()
,
do_readme_rmd()
,
list_macros()
## Not run:
dsl_init()
do_pkgdown()
dsl_get()
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.