| Title | R Markdown Output Formats for Storytelling |
| Version | 0.2 |
| Description | R Markdown output formats based on JavaScript libraries such as Scrollama (https://github.com/russellsamora/scrollama) for storytelling. |
| Imports | htmltools, bookdown, jsonlite |
| Suggests | knitr, rmarkdown |
| License | MIT + file LICENSE |
| URL | https://github.com/yihui/rolldown |
| BugReports | https://github.com/yihui/rolldown/issues |
| VignetteBuilder | knitr |
| Author | Yihui Xie  [aut, cre], Siqi Zhang [ctb], Russell Goldenberg [ctb] |
Rolldown is an R Markdown extension that builds scroll-driven HTML documents for storytelling, a.k.a scrollytelling, powered by JavaScript libraries. Currently, only Scrollama is supported.
1 Installation
install.packages("rolldown", repos = c("https://yihui.r-universe.dev", "https://cloud.r-project.org"))
2 Get started
You can get started with some built-in R Markdown templates in this package. If
you use the RStudio IDE, you can create a new R Markdown document from
File -> New File -> R Markdown -> From Template. Then find a rolldown
template from the list. If you do not use RStudio, you may use the
rmarkdown::draft() function to create a new R Markdown document, e.g.,
# the basic style
rmarkdown::draft('story.Rmd', template = 'scrollama-document', package = 'rolldown')
# the sidebar layout
rmarkdown::draft('story.Rmd', template = 'scrollama-sidebar', package = 'rolldown')
Appendix
To cite the package rolldown in publications, please use:
Xie Y (2025). rolldown: R Markdown Output Formats for Storytelling. R package version 0.2, https://github.com/yihui/rolldown.
@Manual{,
title = {rolldown: R Markdown Output Formats for Storytelling},
author = {Yihui Xie},
year = {2025},
note = {R package version 0.2},
url = {https://github.com/yihui/rolldown},
}