downcute {rmdformats}

Convert to an HTML document

Description

Format for converting from R Markdown to an HTML document.

Usage

downcute(
  fig_width = 8,
  fig_height = 5,
  fig_caption = TRUE,
  lightbox = FALSE,
  thumbnails = FALSE,
  gallery = FALSE,
  toc_depth = 2,
  embed_fonts = TRUE,
  use_bookdown = FALSE,
  pandoc_args = NULL,
  md_extensions = NULL,
  mathjax = "rmdformats",
  highlight = NULL,
  default_style = c("light", "dark"),
  downcute_theme = c("default", "chaos"),
  ...
)

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

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

highlight

syntax highlighting, forced to NULL as highlighting is done via prism.js

default_style

specify default display style, "light" or "dark"

downcute_theme

document template theme

...

Additional function arguments passed to R Markdown html_document

Details

CSS taken from the docute project and adaptations made by John Coene. Please note that as syntax highlighting is done with the Prism JavaScript library, using the 'highlight' argument here will have no effect.

Value

R Markdown output format to pass to render