Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rstudio/quillt

A pkgdown template for the R Markdown Ecosystem
https://github.com/rstudio/quillt

Last synced: about 1 month ago
JSON representation

A pkgdown template for the R Markdown Ecosystem

Awesome Lists containing this project

README 

        
---

output: github_document

---



```{r setup, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```



# quillt 



## Overview



quillt is a package containing helpers functions and resources mainly useful for projects in the R Markdown ecosystem, like creating [pkgdown](https://pkgdown.r-lib.org) websites. Previously, it contained a **pkgdown** template for the R Markdown ecosystem, but now **tidytemplate** is used. 



All those websites are by default aimed to be made available through https://pkgs.rstudio.com/



The goal of quillt is to create a patchwork quilt of all the packages that R Markdown users benefit from. That means packages that help users extend R Markdown using new output formats and templates, or that build upon existing packages to improve the quality of life for R Markdown users. 



## Using themed website for R Markdown ecosystem 



Use this function to creates the necessary files and configurations



```r

quillt::use_quillt_pkgdown()

```

This will leave you with so more steps described in a checklist. Also, some files may be created that you don't want and the checklist will remind you of what to check



## Examples gallery helpers



**quillt** containes some function to help you build a gallery of examples from a yaml file. 



See [Reference page](https://pkgs.rstudio.com/quillt/reference/index.html#section-examples-gallery-helpers) and [examples](articles/examples.html)



## Resources



**quillt** also contains some JS files useful across the website. They are locally copied when creating a new pkgdown website with `use_quillt_pkgdown()`.



You can remove thoses files and associated configuration if you don't need them. See `copy_assets()`.



## Github action template for pkgdown website deployment



`use_github_action_quillt_pkgdown()` will add a Github Action configured to follow the deployment partern of R Markdown ecosystem



* Build on GHA

* Deploy on Netlify using the CLI

* Add the website main url to `pkgs.rstudio.com/`



## Lorem Ipsum



Added to make the readme long enough that I can check scrolling.



Lorem ipsum dolor sit amet, ea pri paulo facete, in mel choro volumus. Dolore labitur cum no, vis copiosae appareat ex, vix antiopam iudicabit consequat in. Has equidem graecis et. Ea est partem altera, ius id agam debitis. Ex mea minim utroque, harum choro at has.



Vim rebum denique ad. Vocent dignissim ea qui, mea no vocent eruditi. At vix soleat bonorum comprehensam, qui nibh sale epicurei te, ex ullum dicta sit. Sed te vide nostrud. Denique delicata ut vim.



Nec no nobis scaevola, ad his commodo qualisque liberavisse. Sed porro propriae repudiare et, enim viris definitionem mei an. Ridens deserunt conceptam usu et. Cu has eros dicit, ex nec idque fabulas. Eum ei sensibus mnesarchum dissentias.



Eum id essent pericula salutandi, cu mazim congue molestiae usu. No has omnesque conclusionemque, no eos nusquam offendit expetendis. Alii oratio ad usu. Et pri feugait recusabo salutandi, ius ad commune salutandi. Ut graece vivendum vim, decore qualisque mediocritatem vix cu.



Ei nullam postea interesset vix, vix eu case fugit graeco, nec ut ponderum deserunt. Has ex amet neglegentur, eos et porro debet eirmod. Te pri lorem persius facilisis. Eos liber mentitum nominavi id.