make_all_docs: Build and deploy all your Rmd documents to your gh-pages site

View source: R/make_all_docs.R

make_all_docsR Documentation

Build and deploy all your Rmd documents to your gh-pages site

Description

Take all your Rmarkdown documents and render to markdown. This function also can deploy all your content at once to your GitHub site.

Usage

make_all_docs(deploy = FALSE)

Arguments

deploy

If TRUE all the Rmd documents will be deploy to your site

Details

The function assumes that all your Rmd files are located in the root of your directory. Every file that is Rmd will be rendered to md and then build with mkdocs followed by the deployment action if param deploy is TRUE.

If you are using your README file as .Rmd, this function will ignore this file.

Author(s)

Ronny Alexander Hernández Mora

Examples

## Not run: 
make_all_docs(deploy = TRUE)

## End(Not run)


ronnyhdez/docmaker documentation built on April 26, 2023, 4:07 p.m.