publish_folder_notes: Publish from folder

View source: R/publish_from_folder.R

publish_folder_notesR Documentation

Publish from folder

Description

This function will take the Rmarkdown file contained in a folder and transform it to a markdown file that can be taken by mkdocs to render a HTML file

Usage

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

Arguments

file

The Rmarkdown 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: 
convert_rmd_md(file = "check.Rmd")

## End(Not run)


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