Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yihui/rolldown
R Markdown output formats for storytelling
https://github.com/yihui/rolldown
r r-markdown r-package storytelling
Last synced: about 1 month ago
JSON representation
R Markdown output formats for storytelling
- Host: GitHub
- URL: https://github.com/yihui/rolldown
- Owner: yihui
- License: other
- Created: 2019-04-15T16:05:08.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-02-06T16:45:05.000Z (almost 5 years ago)
- Last Synced: 2024-08-03T22:22:39.585Z (4 months ago)
- Topics: r, r-markdown, r-package, storytelling
- Language: HTML
- Homepage: https://cran.rstudio.com/package=rolldown
- Size: 158 KB
- Stars: 185
- Watchers: 20
- Forks: 9
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - yihui/rolldown - R Markdown output formats for storytelling (HTML)
README
# rolldown
[](https://travis-ci.com/yihui/rolldown)
**Rolldown** is an [R Markdown](https://rmarkdown.rstudio.com) extension that builds scroll-driven HTML documents for storytelling, a.k.a _scrollytelling_, powered by JavaScript libraries. Currently, only [Scrollama](https://github.com/russellgoldenberg/scrollama) is supported.
## Installation
```r
# Install from GitHub
remotes::install_github("yihui/rolldown")
```
## 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.,
```r
# the basic style
rmarkdown::draft('story.Rmd', template = 'scrollama-document', package = 'rolldown')
# the sidebar layout
rmarkdown::draft('story.Rmd', template = 'scrollama-sidebar', package = 'rolldown')
```