vmodern design - bootstrap HTML output format

Format for converting from R Markdown to an HTML document using the vmodern design theme. The vmodern theme is largely based upon the material design theme from the rmdformats R package. See https://github.com/juba/rmdformats for the source code.

vmodern(
  fig_width = 10,
  fig_height = 8,
  number_sections = FALSE,
  code_folding = "hide",
  code_download = TRUE,
  use_bookdown = TRUE,
  includes = NULL,
  fig_caption = TRUE,
  highlight = "kate",
  lightbox = TRUE,
  thumbnails = FALSE,
  gallery = FALSE,
  cards = TRUE,
  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

number_sections

TRUE to number section headings

code_folding

Enable document readers to toggle the display of R code chunks. Specify "none" to display all code chunks. Specify "hide" or "show" to hide or show all R code chunks by default, and let readers toggle the states on browsers. See the Code folding

code_download

Embed the Rmd source code within the document and provide a link that can be used by readers to download the code.

use_bookdown

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

includes

Named list of additional content to include within the document (typically created using the includes function).

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

cards

if TRUE, sections will be presented as distinct and animated cards

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 rmdformats::material().

Value

R Markdown output format to pass to render

Details

JavaScript and CSS taken and adapted from the Material design theme for Bootstrap 3 project : https://github.com/FezVrasta/bootstrap-material-design.