rstrap_document: HTML document format with a slim Bootstrap 4-derived theme
In rstudio/rsformat: Slimmed-down alternative to rmarkdown::html_document

Description Usage Arguments See Also

View source: R/document_format.R

A substitute for the rmarkdown::html_document() format which uses a slimmed down version of Bootstrap 4. All arguments below behave the same as their rmarkdown::html_document() equivalents.

rstrap_document(
  toc = FALSE,
  toc_depth = 3,
  toc_float = FALSE,
  number_sections = FALSE,
  section_divs = TRUE,
  fig_width = 7,
  fig_height = 5,
  fig_retina = 2,
  fig_caption = TRUE,
  dev = "png",
  df_print = "default",
  code_folding = c("none", "show", "hide"),
  code_download = FALSE,
  smart = TRUE,
  self_contained = TRUE,
  theme = NULL,
  highlight = "default",
  mathjax = "default",
  template = "default",
  extra_dependencies = NULL,
  css = NULL,
  includes = NULL,
  keep_md = FALSE,
  lib_dir = NULL,
  md_extensions = NULL,
  pandoc_args = NULL,
  ...
)

`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
`section_divs`	Wrap sections in `<div>` tags, and attach identifiers to the enclosing `<div>` rather than the header itself.
`fig_width`	Default width (in inches) for figures
`fig_height`	Default height (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
`dev`	Graphics device to use for figure output (defaults to png)
`df_print`	Method to be used for printing data frames. Valid values include "default", "kable", "tibble", and "paged". The "default" method uses a corresponding S3 method of `print`, typically `print.data.frame`. The "kable" method uses the `knitr::kable` function. The "tibble" method uses the tibble package to print a summary of the data frame. The "paged" method creates a paginated HTML table (note that this method is only valid for formats that produce HTML). In addition to the named methods you can also pass an arbitrary function to be used for printing data frames. You can disable the `df_print` behavior entirely by setting the option `rmarkdown.df_print` to `FALSE`. See Data frame printing section in bookdown book for examples.
`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.
`code_download`	Embed the Rmd source code within the document and provide a link that can be used by readers to download the code.
`self_contained`	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 even for self contained documents MathJax is still loaded externally (this is necessary because of its size).
`theme`	`NULL`. For this format, it can't be set to another value or it will error.
`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 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.
`template`	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).
`extra_dependencies`	Additional function arguments to pass to the base R Markdown HTML output formatter `html_document_base`
`css`	CSS and/or Sass files to include. Files with an extension of .sass or .scss are compiled to CSS via `sass::sass()`.
`includes`	Named list of additional content to include within the document (typically created using the `includes` function).
`keep_md`	Keep the markdown file generated by knitting.
`lib_dir`	Directory to copy dependent HTML libraries (e.g. jquery, bootstrap, etc.) into. By default this will be the name of the document with `_files` appended to it.
`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
`...`	Additional function arguments to pass to the base R Markdown HTML output formatter `html_document_base`