View source: R/macro-readme-rmd.R
do_readme_rmd | R Documentation |
do_readme_rmd()
renders an R Markdown README and deploys
the rendered README.md file to Github. It adds default steps to the
"before_deploy"
and "deploy"
stages:
step_setup_ssh()
in the "before_deploy"
to setup
the upcoming deployment
step_setup_push_deploy()
in the "before_deploy"
stage
rmarkdown::render()
in the "deploy"
stage
step_do_push_deploy()
in the "deploy"
stage.
do_readme_rmd(
checkout = TRUE,
remote_url = NULL,
commit_message = NULL,
force = FALSE,
private_key_name = "TIC_DEPLOY_KEY"
)
checkout |
|
remote_url |
|
commit_message |
|
force |
|
private_key_name |
|
Other macros:
do_blogdown()
,
do_bookdown()
,
do_drat()
,
do_package_checks()
,
do_pkgdown()
,
list_macros()
## Not run:
dsl_init()
do_readme_rmd()
dsl_get()
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.