rolldown (version 0.1)

scrollama: 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

# NOT RUN {
rolldown::scrollama_setup(list(step = ".level1", offset = 0.2))
# }