scrollama

0th

Percentile

R Markdown output formats for using Scrollama

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.

Aliases
  • scrollama
  • scrollama_sidebar
  • scrollama_setup
Examples
# NOT RUN {
rolldown::scrollama_setup(list(step = ".level1", offset = 0.2))
# }
Documentation reproduced from package rolldown, version 0.1, License: MIT + file LICENSE

Community examples

Looks like there are no examples yet.