Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/martinctc/parallaxr
Generate a parallax scroll document in R with YAML and Markdown
https://github.com/martinctc/parallaxr
parallax-scroll-document r
Last synced: 23 days ago
JSON representation
Generate a parallax scroll document in R with YAML and Markdown
- Host: GitHub
- URL: https://github.com/martinctc/parallaxr
- Owner: martinctc
- License: gpl-3.0
- Created: 2020-11-14T11:35:56.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2020-12-13T11:42:32.000Z (almost 4 years ago)
- Last Synced: 2024-08-03T22:21:57.250Z (3 months ago)
- Topics: parallax-scroll-document, r
- Language: HTML
- Homepage: https://martinctc.github.io/parallaxr
- Size: 1.22 MB
- Stars: 62
- Watchers: 3
- Forks: 10
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- jimsghstars - martinctc/parallaxr - Generate a parallax scroll document in R with YAML and Markdown (HTML)
README
# parallaxr
Generate a parallax scroll document in R with YAML and Markdown
This is an R package that allows you to create a parallax scroll document with YAML and Markdown files.
Check out this demo output:
https://martinctc.github.io/examples/parallaxr-examples-output.html
You can install the package with the following line of code. Make sure you have **devtools** installed first, of course:
```R
devtools::install_github("martinctc/parallaxr")
```
In the `examples` folder of this repo, you will find the script and the Markdown documents that were used to produce this page. Here is a snippet of the starter code, but please visit the repo for the latest version:
```R
## Load packages
library(parallaxr)
## Character vector of all MD files
all_md_str <- list.files(path = "examples/Markdown", full.names = TRUE)
## Loop through each MD file, parse, and return a single tibble
md_tibble <-
all_md_str %>%
purrr::map_dfr(parse_md) # Return a tibble with row-binding
## Output HTML file
generate_scroll_doc(path = "examples/parallaxr-examples-output.html",
inputs = md_tibble)
```
More documentation is available for the individual functions, e.g.
```R
?generate_scroll_doc
```
You may also visit https://martinctc.github.io/parallaxr/reference.
## Examples
Further examples and use cases can be found below:
- https://frankpopham.github.io/side/ (@frankpopham)
- https://durraniu.github.io/BBC100/ (@durranniu)
Thank you all who have contributed examples! If you would like to add your example to this list, please fork this repo and create a pull request to edit this README page.
## Getting involved
If you have any questions, bugs, or suggestions for enhancements, please log an issue with https://github.com/martinctc/parallaxr/issues. This is an open-source project, so any contribution is very welcome! Pull requests are welcome.