Package 'rolldown'

Title: R Markdown Output Formats for Storytelling
Description: R Markdown output formats based on JavaScript libraries such as 'Scrollama' (<https://github.com/russellgoldenberg/scrollama>) for storytelling.
Authors: Yihui Xie [aut, cre], Siqi Zhang [ctb], Russell Goldenberg [ctb] (The JS library inst/resources/scrollama/scrollama.min.js)
Maintainer: Yihui Xie <[email protected]>
License: MIT + file LICENSE
Version: 0.1.1
Built: 2024-08-23 05:47:52 UTC
Source: https://github.com/yihui/rolldown

Help Index


R Markdown output formats for using Scrollama

Description

Include the Scrollama JS library in the HTML output from R Markdown.

Usage

scrollama(...)

scrollama_sidebar(..., template = pkg_resource("html", "scrollama-side.html"))

scrollama_setup(options = list(step = ".section, img, video, embed", offset = 0.5))

Arguments

..., template

Arguments to be passed to bookdown::html_document2().

options

A list of initialization options for Scrollama.

Value

scrollama() and scrollama_sidebar() return R Markdown output formats; scrollama_setup() is a helper function to return the JavaScript code for initializing Scrollama.

References

The Scrollama library: https://github.com/russellgoldenberg/scrollama.

Examples

rolldown::scrollama_setup(list(step = ".level1", offset = 0.2))