html_document_base: Base output format for HTML-based output formats
In rmarkdown: Dynamic Documents for R

html_document_base

R Documentation

Base output format for HTML-based output formats

Description

Creates an HTML base output format suitable for passing as the base_format argument of the output_format function.

Usage

html_document_base(
  theme = NULL,
  self_contained = TRUE,
  lib_dir = NULL,
  math_method = "default",
  mathjax = "default",
  pandoc_args = NULL,
  template = "default",
  dependency_resolver = NULL,
  copy_resources = FALSE,
  extra_dependencies = NULL,
  css = NULL,
  bootstrap_compatible = FALSE,
  ...
)

Arguments

`theme`	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).
`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).
`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.
`math_method`	Math rendering engine to use. This will define the math method to use with Pandoc. It can be a string for the engine, one of "mathjax", "mathml", "webtex", "katex", "gladtex", or "r-katex" or "default" for `mathjax`. It can be a list of `engine`: one of "mathjax", "mathml", "webtex", "katex", or "gladtex". `url`: A specific url to use with `mathjax`, `katex` or `webtex`. Note that for `engine = "mathjax"`, `url = "local"` will use a local version of MathJax (which is copied into the output directory). For example, output: html_document: math_method: engine: katex url: https://cdn.jsdelivr.net/npm/katex@0.11.1/dist See Pandoc's Manual about Math in HTML for the details about Pandoc supported methods. Using `math_method = "r-katex"` will opt-in server side rendering using KaTeX thanks to katex R package. This is useful compared to `math_method = "katex"` to have no JS dependency, only a CSS dependency for styling equation.
`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.
`pandoc_args`	Additional command line options to pass to pandoc
`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).
`dependency_resolver`	A dependency resolver
`copy_resources`	Copy resources
`extra_dependencies`	Extra dependencies as a list of the `html_dependency` class objects typically generated by `htmltools:htmlDependency()`.
`css`	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.
`bootstrap_compatible`	Bootstrap compatible
`...`	Ignored