https://github.com/rstudio/distill

Distill for R Markdown
https://github.com/rstudio/distill

Last synced: 3 days ago
JSON representation

Distill for R Markdown

• Host: GitHub
• URL: https://github.com/rstudio/distill
• Owner: rstudio
• License: apache-2.0
• Created: 2018-04-23T21:24:50.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2023-11-22T14:46:08.000Z (12 months ago)
• Last Synced: 2024-09-16T14:08:58.873Z (about 2 months ago)
• Language: HTML
• Homepage: https://rstudio.github.io/distill/
• Size: 35.3 MB
• Stars: 423
• Watchers: 17
• Forks: 57
• Open Issues: 148
• Metadata Files:
  • Readme: README.Rmd
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

• jimsghstars - rstudio/distill - Distill for R Markdown (HTML)

README

        
---

output: github_document

editor_options:

  markdown:

    mode: gfm

---

```{r setup, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

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

  out.width = "100%"

)

```

# distill for R Markdown 

[![CRAN status](https://www.r-pkg.org/badges/version/distill)](https://CRAN.R-project.org/package=distill) [![R-CMD-check](https://github.com/rstudio/distill/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/rstudio/distill/actions/workflows/R-CMD-check.yaml) [![Codecov test coverage](https://codecov.io/gh/rstudio/distill/branch/main/graph/badge.svg)](https://app.codecov.io/gh/rstudio/distill?branch=main)

Distill for R Markdown is a web publishing format optimized for scientific and technical communication. Distill articles include:

-   Reader-friendly typography that adapts well to mobile devices.

-   Features essential to technical writing like LaTeX math, citations, and footnotes.

-   Flexible figure layout options (e.g. displaying figures at a larger width than the article text).

-   Attractively rendered tables with optional support for pagination.

-   Support for a wide variety of diagramming tools for illustrating concepts.

-   The ability to incorporate JavaScript and D3-based interactive visualizations.

-   A variety of ways to publish articles, including support for publishing collections or articles as a Distill website.

Distill for R Markdown is based on the [Distill web framework](https://github.com/distillpub/template), which was originally created for use in the Distill Machine Learning Journal. Distill for R Markdown combines the technical authoring features of Distill with [R Markdown](https://rmarkdown.rstudio.com/), enabling a fully reproducible workflow based on literate programming.

## Installation

Install the released version of distill from CRAN:

``` r

install.packages("distill")

```

Or install the development version from GitHub with:

``` r

# install.packages("pak")

pak::pak("rstudio/distill")

```

Learn more about using Distill at .

## Get help

The [RStudio community](https://community.rstudio.com/tag/distill) is a friendly place to ask any questions about distill.

## Code of Conduct

Please note that the distill project is released with a [Contributor Code of Conduct](https://pkgs.rstudio.com/distill/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.