html_clean: Convert to an HTML document

Description Usage Arguments Details Value

Description

Format for converting from R Markdown to an HTML document.

Usage

1
2
3
4
html_clean(fig_width = 6, fig_height = 6, fig_caption = TRUE,
  highlight = "kate", lightbox = TRUE, thumbnails = TRUE,
  gallery = FALSE, pandoc_args = NULL, toc_depth = 2,
  use_bookdown = FALSE, ...)

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

pandoc_args

arguments passed to the pandoc_args argument of rmarkdown html_document

toc_depth

adjust table of contents depth

use_bookdown

if TRUE, uses html_document2 instead of html_document, thus providing numbered sections and cross references

...

Additional function arguments passed to R Markdown html_document

Details

Styling and features are very similar to the ones from the great knitrBootstrap package by Jim Hester : https://github.com/jimhester/knitrBootstrap

Value

R Markdown output format to pass to render



Search within the rmdformats package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.