html_notebook {rmarkdown} | R Documentation

## Convert to an HTML notebook

### Description

Format for converting from R Markdown to an HTML notebook.

### Usage

    html_notebook(toc = FALSE, toc_depth = 3, toc_float = FALSE,
      number_sections = FALSE, fig_width = 7, fig_height = 5,
      fig_retina = 2, fig_caption = TRUE, code_folding = "show",
      smart = TRUE, theme = "default", highlight = "textmate",
      mathjax = "default", extra_dependencies = NULL, css = NULL,
      includes = NULL, md_extensions = NULL, pandoc_args = NULL,
      output_source = NULL, self_contained = TRUE, ...)

### Arguments

`toc` | `TRUE` to include a table of contents in the output
`toc_depth` | Depth of headers to include in table of contents
`toc_float` | `TRUE` to float the table of contents to the left of the main document content. Rather than `TRUE` you may also pass a list of options that control the behavior of the floating table of contents. See the Floating Table of Contents section below for details.
`number_sections` | `TRUE` to number section headings
`fig_width` | Default width (in inches) for figures
`fig_height` | Default width (in inches) for figures
`fig_retina` | Scaling to perform for retina displays (defaults to 2, which currently works for all widely used retina displays). Set to `NULL` to prevent retina scaling. Note that this will always be `NULL` when `keep_md` is specified (this is because `fig_retina` relies on outputting HTML directly into the markdown document).
`fig_caption` | `TRUE` to render figures with captions
`code_folding` | Enable document readers to toggle the display of R code chunks. Specify `"none"` to display all code chunks (assuming they were knit with `echo = TRUE`). Specify `"hide"` to hide all R code chunks by default (users can show hidden code chunks either individually or document-wide). Specify `"show"` to show all R code chunks by default.
`smart` | Produce typographically correct output, converting straight quotes to curly quotes, — to em-dashes, – to en-dashes, and ... to ellipses.
`theme` | Visual theme ("default", "cerulean", "journal", "flatly", "readable", "spacelab", "united", "cosmo", "lumen", "paper", "sandstone", "simplex", or "yeti"). Pass `NULL` for no theme (in this case you can use the `css` parameter to add your own styles).
`highlight` | Syntax highlighting style. Supported styles include "default", "tango", "pygments", "kate", "monochrome", "espresso", "zenburn", "haddock", and "textmate". Pass `NULL` to prevent syntax highlighting.
`mathjax` | 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.
`extra_dependencies` | Additional function arguments to pass to the base R Markdown HTML output formatter `html_document_base`
`css` | One or more css files to include
`includes` | Named list of additional content to include within the document (typically created using the `includes` function).
`md_extensions` | Markdown extensions to be added or removed from the default definition or R Markdown. See the `rmarkdown_format` for additional details.
`pandoc_args` | Additional command line options to pass to pandoc
`output_source` | Define an output source for R chunks (ie, outputs to use instead of those produced by evaluating the underlying R code). See `html_notebook_output` for more details.
`self_contained` | Produce a standalone HTML file with no external dependencies. Defaults to `TRUE`. In notebooks, setting this to `FALSE` is not recommended, since the setting does not apply to embedded notebook output such as plots and HTML widgets.
`...` | Additional function arguments to pass to the base R Markdown HTML output formatter `html_document_base`

### Details

For more details on the HTML file format produced by `html_notebook`, see http://rmarkdown.rstudio.com/r_notebook_format.html.

[Package rmarkdown version 1.3 Index]