TRUE to include a table of contents in the output

Depth of headers to include in table of contents

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.

TRUE to number section headings

Default width (in inches) for figures

Default height (in inches) for figures

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).

TRUE to render figures with captions

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.

One of the following:

• A bslib::bs_theme() object (or a list of bslib::bs_theme() argument values)

  • Use this option for custom themes using Bootstrap 4 or 3.

  • In this case, any .scss/.sass files provided to the css parameter may utilize the theme's underlying Sass utilities (e.g., variables, mixins, etc).

• NULL for no theme (i.e., no html_dependency_bootstrap()).

• A character string specifying a Bootswatch 3 theme name (for backwards-compatibility).

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 a 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.

Additional function arguments to pass to the base R Markdown HTML output formatter html_document_base

CSS and/or Sass files to include. Files with an extension of .sass or .scss are compiled to CSS via sass::sass(). Also, if theme is a bslib::bs_theme() object, Sass code may reference the relevant Bootstrap Sass variables, functions, mixins, etc.

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

Markdown extensions to be added or removed from the default definition or R Markdown. See the rmarkdown_format for additional details.

Additional command line options to pass to pandoc

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.

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