compileMarkdown

0th

Percentile

Compiles a Markdown file

Compiles a Markdown file to HTML.

Keywords
internal, file, IO
Usage
# S3 method for 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 <head> section.

metadata

A named list with meta data that will add as <meta> tags in the HTML <head> section.

verbose

See Verbose.

Details

The input encoding is based on getOption("encoding") and the output encoding is "UTF-8" (forced by markdownToHTML).

Value

Returns the pathname of the generated HTML document.

See Also

Internally, markdownToHTML is used.

Aliases
  • compileMarkdown.default
  • compileMarkdown
Documentation reproduced from package R.rsp, version 0.43.2, License: LGPL (>= 2.1)

Community examples

Looks like there are no examples yet.