readthedown: Convert to an HTML document

In rmdformats: HTML Output Formats and Templates for 'rmarkdown' Documents

Convert to an HTML document

Description

Format for converting from R Markdown to an HTML document.

Usage

readthedown(
  fig_width = 8,
  fig_height = 5,
  fig_caption = TRUE,
  highlight = "kate",
  lightbox = FALSE,
  thumbnails = FALSE,
  gallery = FALSE,
  toc_depth = 2,
  embed_fonts = TRUE,
  use_bookdown = FALSE,
  pandoc_args = NULL,
  md_extensions = NULL,
  mathjax = "rmdformats",
  ...
)

Arguments

fig_width	Default width (in inches) for figures
fig_height	Default width (in inches) for figures
fig_caption	TRUE to render figures with captions
highlight	Syntax highlighting style. Supported styles include "default", "tango", "pygments", "kate", "monochrome", "espresso", "zenburn", "haddock", and "textmate". Pass NULL to prevent syntax highlighting.
lightbox	if TRUE, add lightbox effect to content images
thumbnails	if TRUE display content images as thumbnails
gallery	if TRUE and lightbox is TRUE, add a gallery navigation between images in lightbox display
toc_depth	adjust table of contents depth
embed_fonts	if TRUE, use local files for fonts used in the template. This leads to bigger files but ensures that these fonts are available. If FALSE they are downloaded from Google Web Fonts.
use_bookdown	if TRUE, uses html_document2 instead of html_document, thus providing numbered sections and cross references
pandoc_args	arguments passed to the pandoc_args argument of rmarkdown html_document
md_extensions	arguments passed to the md_extensions argument of rmarkdown html_document
mathjax	set to NULL to disable Mathjax insertion
...	Additional function arguments passed to R Markdown html_document

Details

CSS adapted from the readtheorg theme of the org-html-themes project : https://github.com/fniessen/org-html-themes, which is itself inspired by the Read the docs theme : https://readthedocs.org/.

Value

R Markdown output format to pass to render

rmdformats documentation built on May 17, 2022, 9:05 a.m.