Package 'tufterhandout'

Title: Tufte-style HTML Document Format for rmarkdown
Description: Custom template and output formats for use with rmarkdown. Produce Edward Tufte-style handouts in html formats with full support for rmarkdown features
Authors: Michael C Sachs
Maintainer: Michael C Sachs <[email protected]>
License: MIT + file LICENSE
Version: 1.2.2
Built: 2024-12-19 05:24:01 UTC
Source: https://github.com/sachsmc/tufterhandout

Help Index


html format for tufte-handout

Description

Produces a custom output format function in the style of Edward Tufte's handouts. This essentially recreates the tufte-handout latex document class using bootstrap. Main features are plot hooks that put figures in the margin (marginfigure = TRUE), creates full-width figures (fig.star = TRUE), and allows "sidenotes". To create a sidenote, some raw html is required. Usage is <aside> Content </aside>. See the package vignette for more details.

Usage

html_tufte_handout(self_contained = TRUE, theme = "default",
  lib_dir = NULL, keep_md = FALSE, mathjax = "default",
  pandoc_args = NULL, ...)

Arguments

self_contained

Include all dependencies

theme

Bootstrap theme

lib_dir

Local directory to copy assets

keep_md

Keep knitr-generated markdown

mathjax

Include mathjax, "local" or "default"

pandoc_args

Other arguments to pass to pandoc

...

Additional function arguments to pass to the base R Markdown HTML output formatter