rmarkdown (version 0.1.2)

html_document: Convert to an HTML document


Format for converting from R Markdown to an HTML document.


html_document(toc = FALSE, toc_depth = 3, fig_width = 7, fig_height = 5,
  fig_retina = 2, fig_caption = FALSE, smart = TRUE,
  self_contained = TRUE, theme = "default", highlight = "default",
  mathjax = "default", template = "default", css = NULL,
  includes = NULL, data_dir = NULL, pandoc_args = NULL)



TRUE to include a table of contents in the output


Depth of headers to include in table of contents


Default width (in inches) for figures


Default width (in inches) for figures


Scaling to perform for retina displays (defaults to 2, which currently works for all widely used retina displays). Note that this only takes effect if you are using knitr >= 1.5.21. Set to NULL to prevent retina scaling.


TRUE to render figures with captions


Produce typographically correct output, converting straight quotes to curly quotes, --- to em-dashes, -- to en-dashes, and ... to ellipses.


Produce a standalone HTML file with no external dependencies, using data: URIs to incorporate the contents of linked scripts, stylesheets, images, and videos. Note that if you specify "local" for mathjax then self_contained is automatically set to FALSE.


Visual theme ("default", "cerulean", "journal", "flatly", "readable", "spacelab", "united", "yeti", or "cosmo"). Pass NULL for no theme (in this case you can use the css parameter to add your own styles).


Syntax highlighting style. Supported styles include "default", "tango", "pygments", "kate", "monochrome", "espresso", "zenburn", "haddock", and "textmate". Pass NULL to prevent syntax highlighting.


Include mathjax. The "default" option uses an https URL from the official MathJax CDN. The "local" option uses a local version of MathJax (which is copied into the output directory). You can pass an alternate URL or pass NULL to exclude MathJax entirely.


Pandoc template to use for rendering. Pass "default" to use the rmarkdown package default template; pass NULL to use pandoc's built-in template; pass a path to use a custom template that you've created. Note that if you don't use the "default" template then some features of html_document won't be available (see the Templates section below for more details).


One or more css files to include


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


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


Additional command line options to pass to pandoc


R Markdown output format to pass to render


You can provide a custom HTML template to be used for rendering. The syntax for templates is described in the documentation on pandoc templates. You can also use the basic pandoc template by passing template = NULL.

Note however that if you choose not to use the "default" HTML template then several aspects of HTML document rendering will behave differently:

  • The theme parameter does not work (you can still provide styles using the css parameter).

  • For the highlight parameter, the default highlighting style will resolve to "pygments" and the "textmate" highlighting style is not available

  • MathJax will not work if self_contained is TRUE (these two options can't be used together in normal pandoc templates).

Due to the above restrictions, you might consider using the includes parameter as an alternative to providing a fully custom template.


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.


Run this code

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

render("input.Rmd", html_document(toc = TRUE))
# }

Run the code above in your browser using DataLab