make_doc: Take your Rmarkdown or quarto files to mkdocs

View source: R/make_doc.R

make_docR Documentation

Take your Rmarkdown or quarto files to mkdocs

Description

This function will take your Rmarkdown or quarto files and transform them into a markdown file that can be taken by mkdocs to render a HTML

Usage

make_doc(file, mkdocs_build = FALSE, mkdocs_deploy = FALSE)

Arguments

file

The Rmd or qmd file that we want to convert to markdown

mkdocs_build

TRUE if you want to build the mkdocs documentation. This will run the ⁠mkdocs build --config-file=mkdocs.yml⁠ command

mkdocs_deploy

TRUE if you want to deploy the mkdocs documentation. This will run the ⁠mkdocs gh-deploy --strict --force⁠ command

Author(s)

Ronny Alexander Hernández Mora

Examples

## Not run: 
make_doc(file = "check.Rmd")

## End(Not run)


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