https://github.com/yihui/litedown

A lightweight version of R Markdown
https://github.com/yihui/litedown

litedown markdown r r-markdown r-package report-generator reproducible-research

Last synced: 4 days ago
JSON representation

A lightweight version of R Markdown

• Host: GitHub
• URL: https://github.com/yihui/litedown
• Owner: yihui
• License: other
• Created: 2024-03-12T05:38:30.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-11-28T06:06:34.000Z (14 days ago)
• Last Synced: 2024-12-01T04:35:17.812Z (11 days ago)
• Topics: litedown, markdown, r, r-markdown, r-package, report-generator, reproducible-research
• Language: R
• Homepage: https://yihui.org/litedown/
• Size: 973 KB
• Stars: 182
• Watchers: 7
• Forks: 4
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: NEWS.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - yihui/litedown - A lightweight version of R Markdown (R)

README

        
```         

  ______  

 /   ⚡  \

/litedown\

\   ⚡    /

 \______/

```

# R Markdown Reimagined

[![R-CMD-check](https://github.com/yihui/litedown/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/yihui/litedown/actions/workflows/R-CMD-check.yaml)

[![CRAN

release](https://www.r-pkg.org/badges/version/litedown)](https://cran.r-project.org/package=litedown)

[![litedown on

r-universe](https://yihui.r-universe.dev/badges/litedown)](https://yihui.r-universe.dev/litedown)

This package provides a trimmed-down and reimagined implementation of [R

Markdown](https://rmarkdown.rstudio.com). It is much more lightweight, at the

price of dropping some features. It does not depend on the R package **knitr**

or the system package Pandoc.

Please consider this package experimental for now. The documentation is also

very incomplete and still under development.

## Usage

### Installation

At the moment, you are recommended to install the development version from

r-universe:

``` r

install.packages('litedown', repos = c('https://yihui.r-universe.dev', 'https://cloud.r-project.org'))

```

### Markdown rendering

The function `litedown::mark()` is based on the R package

[**commonmark**](https://github.com/r-lib/commonmark), and renders Markdown to

various output formats supported by **commonmark**, which are primarily HTML and

LaTeX. MS Office formats are not supported.

### Knitting

R Markdown documents need to be knitted to Markdown before being rendered to a

target output format. The function `litedown::fuse()` plays a role similar to

`knitr::knit()` and `rmarkdown::render()`. It fuses program code with

narratives, i.e., it executes code in the source document and interweaves

results with narratives in the output document.

### Previewing

Try `litedown::roam()`.

## Scope

We want to limit the scope of this package. Most planned features have been

(re-)implemented so far, such as reports, slides, books, websites (including

package sites), and paged HTML documents, etc. See the set $R$ below:

$$\mathrm{litedown} = \min{\{R\}} + \{D_i\} - \{D_e\} + \{J\}$$

-   $R$ = **knitr** + **evaluate** + **rmarkdown** + **bookdown** +

    **blogdown** + **pagedown** + **pkgdown** + **xaringan** + **tufte** +

    **distill**

-   $D_i$ = (internal dependencies) **commonmark** + **xfun**

-   $D_e$ = (external dependencies) Pandoc + Bootstrap + jQuery + GitBook +

    Hugo + paged.js + remark.js + tufte.css + distill.js/.css + ...

-   $J$ = Lightweight [vanilla JavaScript/CSS](https://github.com/yihui/lite.js)

Please feel free to file feature requests anyway, but we may be a little

conservative when considering them (we will take votes into consideration, so

please upvote features you like).

## License

The **litedown** package is licensed under MIT.