R: Compiles a Markdown file

compileMarkdown {R.rsp} | R Documentation

## Compiles a Markdown file

### Description

Compiles a Markdown file to HTML.

### Usage

    ## Default S3 method:
    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.

### Author(s)

Henrik Bengtsson

### See Also

Internally, `markdownToHTML` is used.

[Package R.rsp version 0.41.0 Index]