https://github.com/jhelvy/renderthis
An R package for building xaringan slides into multiple outputs, including html, pdf, png, gif, pptx, and mp4.
https://github.com/jhelvy/renderthis
gif mp4 pdf png quarto quartopub r r-package rmarkdown rstats slides xaringan
Last synced: 8 days ago
JSON representation
An R package for building xaringan slides into multiple outputs, including html, pdf, png, gif, pptx, and mp4.
- Host: GitHub
- URL: https://github.com/jhelvy/renderthis
- Owner: jhelvy
- License: other
- Created: 2020-09-27T15:30:05.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-10-08T02:02:54.000Z (over 1 year ago)
- Last Synced: 2024-04-10T06:07:28.389Z (about 1 year ago)
- Topics: gif, mp4, pdf, png, quarto, quartopub, r, r-package, rmarkdown, rstats, slides, xaringan
- Language: HTML
- Homepage: https://jhelvy.github.io/renderthis
- Size: 21.9 MB
- Stars: 171
- Watchers: 3
- Forks: 11
- Open Issues: 18
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - jhelvy/renderthis - An R package for building xaringan slides into multiple outputs, including html, pdf, png, gif, pptx, and mp4. (HTML)
README
---
output:
github_document:
html_preview: false
---
[rmarkdown]: https://rmarkdown.rstudio.com
[quarto]: https://quarto.org
[xaringan]: https://slides.yihui.org/xaringan/
[revealjs]: https://quarto.org/docs/presentations/revealjs/
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
results = "asis",
comment = "#>",
out.width = "100%",
eval = FALSE
)
IS_README <- TRUE
```
# renderthis 
[](https://github.com/jhelvy/renderthis/actions)
[](https://CRAN.R-project.org/package=renderthis)
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
This package contains functions for rendering [R Markdown][rmarkdown] and [Quarto][quarto] documents — priamrily [xaringan] or [revealjs] slides — to different formats, including HTML, PDF, PNG, GIF, PPTX, and MP4, as well as a 'social' output, a png of the first slide re-sized for sharing on social media.
**Looking for xaringanBuilder?**
The `renderthis` package was previously called `xaringanBuilder`. We updated the name as the package evolved (see [this blog post](https://www.jhelvy.com/blog/2022-06-28-introducing-renderthis/) detailing the package's history)
If you need to install `xaringanBuilder` under the previous package name,
[see the instructions below](#installing-xaringanbuilder).
## Installation
**Note**: To get the most out of renderthis, we recommend installing the
package **with dependencies** and making sure that you have a local
installation of Google Chrome. See the
[Setup](https://jhelvy.github.io/renderthis/articles/renderthis-setup.html)
page for details.
Since `renderthis` is temporarily not on CRAN (we'll eventually get it back up), you can install it from GitHub with:
```{r}
# install.packages("pak")
pak::pak("jhelvy/renderthis")
```
Some output formats require additional packages, and each format will provide
instructions about how to install any missing dependencies. You can also
choose to install `renderthis` with all of its dependencies:
```{r}
# From GitHub
pak::pak("jhelvy/renderthis", dependencies = TRUE)
```
## Usage
```{r child="man/fragments/usage.Rmd", eval = TRUE}
```
Learn more about renderthis in the
[Get Started article](https://jhelvy.github.io/renderthis/articles/renderthis.html).
## Author and License Information
- Authors: [John Paul Helveston](https://www.jhelvy.com/) (_aut_, _cre_, _cph_) & [Garrick Aden-Buie](https://www.garrickadenbuie.com/) (_aut_)
- Date First Written: Originally as {xaringanBuilder} on *September 27, 2020*
- License: [MIT](https://github.com/jhelvy/renderthis/blob/master/LICENSE.md)
## Citation Information
If you use this package in a publication, I would greatly appreciate it if you cited it. You can get the citation information by typing `citation("renderthis")` into R:
```{r, echo = FALSE, eval = TRUE, results='asis'}
citation("renderthis")
```
## Installing xaringanBuilder
If you want, you can still install the `xaringanBuilder` package as it was just prior to the name change with:
```r
remotes::install_github("jhelvy/[email protected]")
```
Even though the install command mentions `renderthis`, the package will be installed as xaringanBuilder.