rmarkdown (version 0.1.2)

md_document: Convert to a markdown document

Description

Format for converting from R Markdown to another variant of markdown (e.g. strict markdown or github flavored markdown)

Usage

md_document(variant = "markdown_strict", toc = FALSE, toc_depth = 3,
  fig_width = 7, fig_height = 5, fig_retina = NULL, includes = NULL,
  data_dir = NULL, pandoc_args = NULL)

Arguments

variant

Markdown variant to produce (defaults to "markdown_strict"). Other valid values are "markdown_github", "markdown_mmd", markdown_phpextra", or even "markdown" (which produces pandoc markdown). You can also compose custom markdown variants, see the documentation on pandoc's markdown for details.

fig_retina

Scaling to perform for retina displays. Defaults to NULL which performs no scaling. A setting of 2 will work for all widely used retina displays, but will also result in the output of <img> tags rather than markdown images due to the need to set the width of the image explicitly. Note that this only takes effect if you are using knitr >= 1.5.21.

toc

TRUE to include a table of contents in the output

toc_depth

Depth of headers to include in table of contents

fig_width

Default width (in inches) for figures

fig_height

Default width (in inches) for figures

includes

Named list of additional content to include within the document (typically created using the includes function).

data_dir

Additional directory to resolve relatives paths of templates and included content against (the directory of the input file is used by default).

pandoc_args

Additional command line options to pass to pandoc

Value

R Markdown output format to pass to render

Details

R Markdown documents can have optional metadata that is used to generate a document header that includes the title, author, and date. Metadata can also be provided to enable the use of footnotes and bibliographies. For more details see the documentation on R Markdown metadata and citations.

Examples

Run this code
# NOT RUN {
library(rmarkdown)

render("input.Rmd", md_document())

render("input.Rmd", md_document(variant = "github_flavored_markdown"))
# }

Run the code above in your browser using DataCamp Workspace