Learn R
knitr (version 1.6)

knit2html: Convert markdown to HTML using knit() and markdownToHTML()

Description

This is a convenience function to knit the input markdown source and call markdownToHTML() in the markdown package to convert the result to HTML.

Usage

knit2html(input, output = NULL, ..., envir = parent.frame(), text = NULL, quiet = FALSE, 
    encoding = getOption("encoding"))

Arguments

...
options passed to markdownToHTML
input
path of the input file
output
path of the output file for knit(); if NULL, this function will try to guess and it will be under the current working directory
envir
the environment in which the code chunks are to be evaluated (can use new.env() to guarantee an empty new environment)
text
a character vector as an alternative way to provide the input file
quiet
whether to suppress the progress bar and messages
encoding
the encoding of the input file; see file

Value

  • If the argument text is NULL, a character string (HTML code) is returned; otherwise the result is written into a file and the filename is returned.

See Also

knit, markdownToHTML

Examples

Run this code
# a minimal example
writeLines(c("# hello markdown", "```{r hello-random, echo=TRUE}", "rnorm(5)", "```"), 
    "test.Rmd")
knit2html("test.Rmd")
if (interactive()) browseURL("test.html")

Run the code above in your browser using DataCamp Workspace