Learn R Programming

R.rsp (version 0.20.0)

compileMarkdown: Compiles a Markdown file

Description

Compiles a Markdown file to HTML.

Usage

## S3 method for class 'default':
compileMarkdown(filename, path=NULL, ..., outPath=".", header=NULL,
  metadata=getMetadata(filename), verbose=FALSE)

Arguments

filename, path
The filename and (optional) path of the Markdown document to be compiled.
...
Additional arguments passed to markdownToHTML.
outPath
The output and working directory.
header
character vector of valid HTML strings that should be added to the HTML section.
metadata
A named list with meta data that will add as tags in the HTML section.
verbose
See Verbose.

Value

  • Returns the pathname of the generated HTML document.

See Also

Internally, markdownToHTML is used.