Litedown

https://github.com/yihui/litedown
Admin
Litedown is a lightweight, reimagined implementation of R Markdown that provides document knitting...
Tokens:29,031
Snippets:233
Trust Score:9.8
Update:6 months ago
Show doc for...
Tokens:
Raw
### Initialize webR and R environment

Source: https://github.com/yihui/litedown/blob/main/site/playground/index.html

Sets up the webR instance, initializes a shelter, and installs required R packages including litedown.

```javascript
async function initWebR() { setLoading('Loading webR (this may take a moment)…'); const { WebR } = await import('https://webr.r-wasm.org/latest/webr.mjs'); webR = new WebR(); await webR.init(); shelter = await new webR.Shelter(); // `codetools` is a recommended base-R package not bundled with webR but // required during code evaluation (used internally by the R evaluator). setLoading('Installing R packages…'); await webR.evalRVoid( 'webr::shim_install(); webr::install(c("commonmark", "xfun", "litedown", "codetools"), repos = c("https://yihui.r-universe.dev", "https://repo.r-wasm.org"), quiet = TRUE)' ); // Run setup.R if present in the playground directory try { const setupRes = await fetch('./setup.R'); if (setupRes.ok) { setLoading('Running setup.R…'); await webR.evalRVoid(await setupRes.text()); } } catch (_) { /* setup.R not present */ } setLoading('Ready!'); }
```

--------------------------------

### Get Package Description

Source: https://context7.com/yihui/litedown/llms.txt

Retrieves the package description for litedown. No setup required.

```r
litedown::pkg_desc()
```

--------------------------------

### LaTeX Output Examples

Source: https://github.com/yihui/litedown/blob/main/examples/test-options.md

Demonstrates generating LaTeX output with table of contents and hard breaks.

```r
# temporarily override mark()
mark = function(...) litedown::mark(..., output = 'latex')
# toc example
mkd <- c('# Header 1', 'p1', '## Header 2', 'p2')

mark(mkd, options = '+number_sections')
```

```latex
\section{Header 1}

p1

\subsection{Header 2}

p2
```

```r
mark(mkd, options = '+number_sections+toc')
```

```latex
\tableofcontents
\section{Header 1}

p1

\subsection{Header 2}

p2
```

```r
mark('foo
bar
')
```

```latex
foo
bar
```

```r
mark('foo
bar
', options = '+hardbreaks')
```

```latex
foo\\
bar
```

--------------------------------

### Display R output

Source: https://github.com/yihui/litedown/blob/main/examples/020-inline.md

Example of the resulting output from the numeric formatting code.

```text
#> [1] "1.234568"          "123456.789000"     "-1234567.890000"  
#> [4] "1234567890.000000" "0.000001"
```

--------------------------------

### Load litedown library

Source: https://github.com/yihui/litedown/blob/main/examples/test-options.md

Loads the litedown package in R. Ensure the package is installed before running.

```r
library(litedown)
```

--------------------------------

### Get Package News

Source: https://context7.com/yihui/litedown/llms.txt

Retrieves the package news for litedown. No setup required.

```r
litedown::pkg_news()
```

--------------------------------

### Convert LaTeX Math

Source: https://github.com/yihui/litedown/blob/main/examples/test-options.md

Demonstrates rendering inline and display math in LaTeX. The second example shows how to disable this feature using the -latex_math option.

```r
mkd <- c(
  '`$x$` is inline math $x$!', '', 'Display style:', '', '$$x + y$$', '',
  '\begin{align}
a^{2}+b^{2} & = c^{2}\\
\sin^{2}(x)+\cos^{2}(x) & = 1
\end{align}'
)

mark(mkd)
```

```r
mark(mkd, options = '-latex_math')
```

--------------------------------

### Install litedown from r-universe

Source: https://github.com/yihui/litedown/blob/main/README.md

Install the development version of the litedown package from the r-universe repository. Ensure you include the CRAN repository for base packages.

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

--------------------------------

### Managing Chunk Options with reactor

Source: https://context7.com/yihui/litedown/llms.txt

Gets or sets global and local chunk execution options.

```r
library(litedown)

# Get single option value
litedown::reactor("echo")
#> TRUE

# Get multiple option values
litedown::reactor(c("echo", "fig.width"))
#> $echo
#> [1] TRUE
#> $fig.width
#> [1] 7

# Set options (returns old values for restoration)
old <- litedown::reactor(echo = FALSE, fig.width = 8)
litedown::reactor(c("echo", "fig.width"))
#> $echo
#> [1] FALSE
#> $fig.width
#> [1] 8
```

--------------------------------

### Plot with Default PNG Device

Source: https://github.com/yihui/litedown/blob/main/examples/008-option-device.md

Generates a plot using the default PNG graphics device with a higher resolution. No specific setup is required beyond standard R plotting.

```r
plot(cars)
```

--------------------------------

### reactor - Get and Set Chunk Options

Source: https://context7.com/yihui/litedown/llms.txt

The `reactor()` function manages global and local chunk options for code execution. Options control behavior like whether to show code (`echo`), evaluate code (`eval`), figure dimensions, and more.

```APIDOC
## reactor - Get and Set Chunk Options

The `reactor()` function manages global and local chunk options for code execution. Options control behavior like whether to show code (`echo`), evaluate code (`eval`), figure dimensions, and more.

### Request Example
```r
library(litedown)

# Get single option value
litedown::reactor("echo")
#> TRUE

# Get multiple option values
litedown::reactor(c("echo", "fig.width"))
#> $echo
#> [1] TRUE
#> $fig.width
#> [1] 7

# Set options (returns old values for restoration)
old <- litedown::reactor(echo = FALSE, fig.width = 8)
litedown::reactor(c("echo", "fig.width"))
#> $echo
#> [1] FALSE
#> $fig.width
#> [1] 8
```
```

--------------------------------

### Live Previewing with roam

Source: https://context7.com/yihui/litedown/llms.txt

Launches a local web server for live-previewing Markdown and R Markdown files.

```r
library(litedown)

# Preview files in current directory
roam()

# Preview files in a specific directory
roam("path/to/docs")

# Disable live preview (manual refresh required)
roam(live = FALSE)

# Customize server options
roam(dir = ".", live = TRUE, port = 4321)

# The function returns a URL invisibly
url <- roam()
# Browse to the returned URL to see the file listing
# Click on .Rmd/.md files to preview them
# Files are rendered to HTML in memory (no files written to disk)
```

--------------------------------

### roam - Live Preview Documents

Source: https://context7.com/yihui/litedown/llms.txt

The `roam()` function launches a local web server for live-previewing Markdown and R Markdown files. Changes to files are automatically reflected in the browser without manual refresh.

```APIDOC
## roam - Live Preview Documents

The `roam()` function launches a local web server for live-previewing Markdown and R Markdown files. Changes to files are automatically reflected in the browser without manual refresh.

### Request Example
```r
library(litedown)

# Preview files in current directory
roam()

# Preview files in a specific directory
roam("path/to/docs")

# Disable live preview (manual refresh required)
roam(live = FALSE)

# Customize server options
roam(dir = ".", live = TRUE, port = 4321)

# The function returns a URL invisibly
url <- roam()
# Browse to the returned URL to see the file listing
# Click on .Rmd/.md files to preview them
# Files are rendered to HTML in memory (no files written to disk)
```
```

--------------------------------

### Building Websites with fuse_site

Source: https://context7.com/yihui/litedown/llms.txt

Builds a website by rendering R Markdown documents individually based on site-wide configuration.

```r
library(litedown)

# Build site from current directory
fuse_site()

# Build from specific directory
fuse_site("site_dir/")

# Build specific files only
fuse_site(c("index.Rmd", "about.Rmd"))
```

--------------------------------

### Initialize Dygraph Chart

Source: https://github.com/yihui/litedown/blob/main/examples/022-dygraphs.md

Create a new Dygraph instance with the provided sunspot data points.

```js
const g = new Dygraph(
  document.getElementById('graph-sunspot'),
  [
  [1700, 5],
  [1701, 11],
  [1702, 16],
  [1703, 23],
  [1704, 36],
  [1705, 58],
  [1706, 29],
  [1707, 20],
  [1708, 10],
  [1709, 8],
  [1710, 3],
  [1711, 0],
  [1712, 0],
  [1713, 2],
  [1714, 11],
  [1715, 27],
  [1716, 47],
  [1717, 63],
  [1718, 60],
  [1719, 39],
  [1720, 28],
  [1721, 26],
  [1722, 22],
  [1723, 11],
  [1724, 21],
  [1725, 40],
  [1726, 78],
  [1727, 122],
  [1728, 103],
  [1729, 73],
  [1730, 47],
  [1731, 35],
  [1732, 11],
  [1733, 5],
  [1734, 16],
  [1735, 34],
  [1736, 70],
  [1737, 81],
  [1738, 111],
  [1739, 101],
  [1740, 73],
  [1741, 40],
  [1742, 20],
  [1743, 16],
  [1744, 5],
  [1745, 11],
  [1746, 22],
  [1747, 40],
  [1748, 60],
  [1749, 80.9],
  [1750, 83.4],
  [1751, 47.7],
  [1752, 47.8],
  [1753, 30.7],
  [1754, 12.2],
  [1755, 9.6],
  [1756, 10.2],
  [1757, 32.4],
  [1758, 47.6],
  [1759, 54],
  [1760, 62.9],
  [1761, 85.9],
  [1762, 61.2],
  [1763, 45.1],
  [1764, 36.4],
  [1765, 20.9],
  [1766, 11.4],
  [1767, 37.8],
  [1768, 69.8],
  [1769, 106.1],
  [1770, 100.8],
  [1771, 81.6],
  [1772, 66.5],
  [1773, 34.8],
  [1774, 30.6],
  [1775, 7],
  [1776, 19.8],
  [1777, 92.5],
  [1778, 154.4],
  [1779, 125.9],
  [1780, 84.8],
  [1781, 68.1],
  [1782, 38.5],
  [1783, 22.8],
  [1784, 10.2],
  [1785, 24.1],
  [1786, 82.9],
  [1787, 132],
  [1788, 130.9],
  [1789, 118.1],
  [1790, 89.9],
  [1791, 66.6],
  [1792, 60],
  [1793, 46.9],
  [1794, 41],
  [1795, 21.3],
  [1796, 16],
  [1797, 6.4],
  [1798, 4.1],
  [1799, 6.8],
  [1800, 14.5],
  [1801, 34],
  [1802, 45],
  [1803, 43.1],
  [1804, 47.5],
  [1805, 42.2],
  [1806, 28.1],
  [1807, 10.1],
  [1808, 8.1],
  [1809, 2.5],
  [1810, 0],
  [1811, 1.4],
  [1812, 5],
  [1813, 12.2],
  [1814, 13.9],
  [1815, 35.4],
  [1816, 45.8],
  [1817, 41.1],
  [1818, 30.1],
  [1819, 23.9],
  [1820, 15.6],
  [1821, 6.6],
  [1822, 4],
  [1823, 1.8],
  [1824, 8.5],
  [1825, 16.6],
  [1826, 36.3],
  [1827, 49.6],
  [1828, 64.2],
  [1829, 67],
  [1830, 70.9],
  [1831, 47.8],
  [1832, 27.5],
  [1833, 8.5],
  [1834, 13.2],
  [1835, 56.9],
  [1836, 121.5],
  [1837, 138.3],
  [1838, 103.2],
  [1839, 85.7],
  [1840, 64.6],
  [1841, 36.7],
  [1842, 24.2],
  [1843, 10.7],
  [1844, 15],
  [1845, 40.1],
  [1846, 61.5],
  [1847, 98.5],
  [1848, 124.7],
  [1849, 96.3],
  [1850, 66.6],
  [1851, 64.5],
  [1852, 54.1],
  [1853, 39],
  [1854, 20.6],
  [1855, 6.7],
  [1856, 4.3],
  [1857, 22.7],
  [1858, 54.8],
  [1859, 93.8],
  [1860, 95.8],
  [1861, 77.2],
  [1862, 59.1],
  [1863, 44],
  [1864, 47],
  [1865, 30.5],
  [1866, 16.3],
  [1867, 7.3],
  [1868, 37.6],
  [1869, 74],
  [1870, 139],
  [1871, 111.2],
  [1872, 101.6],
  [1873, 66.2],
  [1874, 44.7],
  [1875, 17],
  [1876, 11.3],
  [1877, 12.4],
  [1878, 3.4],
  [1879, 6],
  [1880, 32.3],
  [1881, 54.3],
  [1882, 59.7],
  [1883, 63.7],
  [1884, 63.5],
  [1885, 52.2],
  [1886, 25.4],
  [1887, 13.1],
  [1888, 6.8],
  [1889, 6.3],
  [1890, 7.1],
  [1891, 35.6],
  [1892, 73],
  [1893, 85.1],
  [1894, 78],
  [1895, 64],
  [1896, 41.8],
  [1897, 26.2],
  [1898, 26.7],
  [1899, 12.1],
  [1900, 9.5],
  [1901, 2.7],
  [1902, 5],
  [1903, 24.4],
  [1904, 42],
  [1905, 63.5],
  [1906, 53.8],
  [1907, 62],
  [1908, 48.5],
  [1909, 43.9],
  [1910, 18.6],
  [1911, 5.7],
  [1912, 3.6],
  [1913, 1.4],
  [1914, 9.6],
  [1915, 47.4],
  [1916, 57.1],
  [1917, 103.9],
  [1918, 80.6],
  [1919, 63.6],
  [1920, 37.6],
  [1921, 26.1],
  [1922, 14.2],
  [1923, 5.8],
  [1924, 16.7],
  [1925, 44.3],
  [1926, 63.9],
  [1927, 69],
  [1928, 77.8],
  [1929, 64.9],
  [1930, 35.7],
  [1931, 21.2],
  [1932, 11.1],
  [1933, 5.7],
  [1934, 8.7],
  [1935, 36.1],
  [1936, 79.7],
  [1937, 114.4],
  [1938, 109.6],
  [1939, 88.8],
  [1940, 67.8],
  [1941, 47.5],
  [1942, 30.6],
  [1943, 16.3],
  [1944, 9.6],
  [1945, 33.2],
  [1946, 92.6],
  [1947, 151.6],
  [1948, 136.3],
  [1949, 134.7],
  [1950, 83.9],
  [1951, 69.4],
  [1952, 31.5],
  [1953, 13.9],
  [1954, 4.4],
  [1955, 38],
  [1956, 141.7],
  [1957, 190.2],
  [1958, 184.8],
  [1959, 159],
  [1960, 112.3],
  [1961, 53.9],
  [1962, 37.5],
  [1963, 27.9],
  [1964, 10.2],
  [1965, 15.1],
  [1966, 47],
  [1967, 93.8],
  [1968, 105.9],
  [1969, 105.5],
  [1970, 104.5],
  [1971, 66.6],
  [1972, 68.9],
  [1973, 38],
  [1974, 34.5],
  [1975, 15.5],
  [1976, 12.6],
  [1977, 27.5],
  [1978, 92.5],
  [1979, 155.4],
  [1980, 154.7],
  [1981, 140.5],
  [1982, 115.9],
  [1983, 66.6]
  ]
);
```

--------------------------------

### Create Sunspot Graph with Annotations

Source: https://github.com/yihui/litedown/blob/main/examples/022-dygraphs.md

Initializes a Dygraph with sunspot data and configures annotations for specific data points. Ensure the target element exists and Dygraphs library is loaded.

```javascript
const g = new Dygraph(
  document.getElementById('graph-sunspot'),
  [
  [1700, 5],
  [1701, 11],
  [1702, 16],
  [1703, 23],
  [1704, 36],
  [1705, 58],
  [1706, 29],
  [1707, 20],
  [1708, 10],
  [1709, 8],
  [1710, 3],
  [1711, 0],
  [1712, 0],
  [1713, 2],
  [1714, 11],
  [1715, 27],
  [1716, 47],
  [1717, 63],
  [1718, 60],
  [1719, 39],
  [1720, 28],
  [1721, 26],
  [1722, 22],
  [1723, 11],
  [1724, 21],
  [1725, 40],
  [1726, 78],
  [1727, 122],
  [1728, 103],
  [1729, 73],
  [1730, 47],
  [1731, 35],
  [1732, 11],
  [1733, 5],
  [1734, 16],
  [1735, 34],
  [1736, 70],
  [1737, 81],
  [1738, 111],
  [1739, 101],
  [1740, 73],
  [1741, 40],
  [1742, 20],
  [1743, 16],
  [1744, 5],
  [1745, 11],
  [1746, 22],
  [1747, 40],
  [1748, 60],
  [1749, 80.9],
  [1750, 83.4],
  [1751, 47.7],
  [1752, 47.8],
  [1753, 30.7],
  [1754, 12.2],
  [1755, 9.6],
  [1756, 10.2],
  [1757, 32.4],
  [1758, 47.6],
  [1759, 54],
  [1760, 62.9],
  [1761, 85.9],
  [1762, 61.2],
  [1763, 45.1],
  [1764, 36.4],
  [1765, 20.9],
  [1766, 11.4],
  [1767, 37.8],
  [1768, 69.8],
  [1769, 106.1],
  [1770, 100.8],
  [1771, 81.6],
  [1772, 66.5],
  [1773, 34.8],
  [1774, 30.6],
  [1775, 7],
  [1776, 19.8],
  [1777, 92.5],
  [1778, 154.4],
  [1779, 125.9],
  [1780, 84.8],
  [1781, 68.1],
  [1782, 38.5],
  [1783, 22.8],
  [1784, 10.2],
  [1785, 24.1],
  [1786, 82.9],
  [1787, 132],
  [1788, 130.9],
  [1789, 118.1],
  [1790, 89.9],
  [1791, 66.6],
  [1792, 60],
  [1793, 46.9],
  [1794, 41],
  [1795, 21.3],
  [1796, 16],
  [1797, 6.4],
  [1798, 4.1],
  [1799, 6.8],
  [1800, 14.5],
  [1801, 34],
  [1802, 45],
  [1803, 43.1],
  [1804, 47.5],
  [1805, 42.2],
  [1806, 28.1],
  [1807, 10.1],
  [1808, 8.1],
  [1809, 2.5],
  [1810, 0],
  [1811, 1.4],
  [1812, 5],
  [1813, 12.2],
  [1814, 13.9],
  [1815, 35.4],
  [1816, 45.8],
  [1817, 41.1],
  [1818, 30.1],
  [1819, 23.9],
  [1820, 15.6],
  [1821, 6.6],
  [1822, 4],
  [1823, 1.8],
  [1824, 8.5],
  [1825, 16.6],
  [1826, 36.3],
  [1827, 49.6],
  [1828, 64.2],
  [1829, 67],
  [1830, 70.9],
  [1831, 47.8],
  [1832, 27.5],
  [1833, 8.5],
  [1834, 13.2],
  [1835, 56.9],
  [1836, 121.5],
  [1837, 138.3],
  [1838, 103.2],
  [1839, 85.7],
  [1840, 64.6],
  [1841, 36.7],
  [1842, 24.2],
  [1843, 10.7],
  [1844, 15],
  [1845, 40.1],
  [1846, 61.5],
  [1847, 98.5],
  [1848, 124.7],
  [1849, 96.3],
  [1850, 66.6],
  [1851, 64.5],
  [1852, 54.1],
  [1853, 39],
  [1854, 20.6],
  [1855, 6.7],
  [1856, 4.3],
  [1857, 22.7],
  [1858, 54.8],
  [1859, 93.8],
  [1860, 95.8],
  [1861, 77.2],
  [1862, 59.1],
  [1863, 44],
  [1864, 47],
  [1865, 30.5],
  [1866, 16.3],
  [1867, 7.3],
  [1868, 37.6],
  [1869, 74],
  [1870, 139],
  [1871, 111.2],
  [1872, 101.6],
  [1873, 66.2],
  [1874, 44.7],
  [1875, 17],
  [1876, 11.3],
  [1877, 12.4],
  [1878, 3.4],
  [1879, 6],
  [1880, 32.3],
  [1881, 54.3],
  [1882, 59.7],
  [1883, 63.7],
  [1884, 63.5],
  [1885, 52.2],
  [1886, 25.4],
  [1887, 13.1],
  [1888, 6.8],
  [1889, 6.3],
  [1890, 7.1],
  [1891, 35.6],
  [1892, 73],
  [1893, 85.1],
  [1894, 78],
  [1895, 64],
  [1896, 41.8],
  [1897, 26.2],
  [1898, 26.7],
  [1899, 12.1],
  [1900, 9.5],
  [1901, 2.7],
  [1902, 5],
  [1903, 24.4],
  [1904, 42],
  [1905, 63.5],
  [1906, 53.8],
  [1907, 62],
  [1908, 48.5],
  [1909, 43.9],
  [1910, 18.6],
  [1911, 5.7],
  [1912, 3.6],
  [1913, 1.4],
  [1914, 9.6],
  [1915, 47.4],
  [1916, 57.1],
  [1917, 103.9],
  [1918, 80.6],
  [1919, 63.6],
  [1920, 37.6],
  [1921, 26.1],
  [1922, 14.2],
  [1923, 5.8],
  [1924, 16.7],
  [1925, 44.3],
  [1926, 63.9],
  [1927, 69],
  [1928, 77.8],
  [1929, 64.9],
  [1930, 35.7],
  [1931, 21.2],
  [1932, 11.1],
  [1933, 5.7],
  [1934, 8.7],
  [1935, 36.1],
  [1936, 79.7],
  [1937, 114.4],
  [1938, 109.6],
  [1939, 88.8],
  [1940, 67.8],
  [1941, 47.5],
  [1942, 30.6],
  [1943, 16.3],
  [1944, 9.6],
  [1945, 33.2],
  [1946, 92.6],
  [1947, 151.6],
  [1948, 136.3],
  [1949, 134.7],
  [1950, 83.9],
  [1951, 69.4],
  [1952, 31.5],
  [1953, 13.9],
  [1954, 4.4],
  [1955, 38],
  [1956, 141.7],
  [1957, 190.2],
  [1958, 184.8],
  [1959, 159],
  [1960, 112.3],
  [1961, 53.9],
  [1962, 37.5],
  [1963, 27.9],
  [1964, 10.2],
  [1965, 15.1],
  [1966, 47],
  [1967, 93.8],
  [1968, 105.9],
  [1969, 105.5],
  [1970, 104.5],
  [1971, 66.6],
  [1972, 68.9],
  [1973, 38],
  [1974, 34.5],
  [1975, 15.5],
  [1976, 12.6],
  [1977, 27.5],
  [1978, 92.5],
  [1979, 155.4],
  [1980, 154.7],
  [1981, 140.5],
  [1982, 115.9],
  [1983, 66.6],
  [1984, 45.9],
  [1985, 17.9],
  [1986, 13.4],
  [1987, 29.2],
  [1988, 100.2]
],
  {
    labels: ["Year", "Sunspots"],
    showRangeSelector: true
  }
);
// annotate the maximum
g.ready(() => g.setAnnotations([
  {
    series: "Sunspots",
    x: 1957,
    shortText: "M",
    text: "Maximum number"
  }
]));
```

--------------------------------

### JavaScript object keys extraction

Source: https://github.com/yihui/litedown/blob/main/examples/015-fill-chunk.md

This JavaScript code extracts column names from a data object. It's a basic example of object manipulation in JavaScript.

```js
const data = {
  "Sepal.Length": [5.1, 4.9, 4.7, 4.6, 5],
  "Sepal.Width": [3.5, 3, 3.2, 3.1, 3.6]
};
Object.keys(data);  // column names
```

--------------------------------

### Process fenced Divs

Source: https://github.com/yihui/litedown/blob/main/examples/test-options.md

Shows how to create div elements with classes, IDs, and styles.

```r
mark('::: foo
asdf
:::')
```

```r
mark('::: {.foo .bar #baz style="color: red;"}
asdf
:::')
```

--------------------------------

### Monte Carlo estimation of Pi in R

Source: https://github.com/yihui/litedown/blob/main/examples/015-fill-chunk.md

This R code estimates the value of Pi using a Monte Carlo method. It requires no special setup beyond standard R.

```r
f = function() {
  n = 0
  for (i in 1:10000) {
    x = runif(1); y = runif(1)
    if (x^2 + y^2 <= 1) {
      n = n + 1
    }
  }
  n/10000 * 4
}
abs(f() - pi) <= 0.1  # is it close to pi?
```

--------------------------------

### fuse_site - Build Websites

Source: https://context7.com/yihui/litedown/llms.txt

The `fuse_site()` function builds a website by rendering R Markdown documents individually. It uses a `_litedown.yml` config file to define site-wide settings.

```APIDOC
## fuse_site - Build Websites

The `fuse_site()` function builds a website by rendering R Markdown documents individually. It uses a `_litedown.yml` config file to define site-wide settings.

### Request Example
```r
library(litedown)

# Build site from current directory
fuse_site()

# Build from specific directory
fuse_site("site_dir/")

# Build specific files only
fuse_site(c("index.Rmd", "about.Rmd"))

# Configure via _litedown.yml in site root:
# ---
# site:
#   rebuild: "outdated"    # Only rebuild changed files
#   pattern: "[.]R?md$"    # File pattern to match
# output:
#   html:
#     meta:
#       css: ["@default"]
#       include_before: "[Home](/) [About](/about.html)"
#       include_after: "&copy; 2024 | [Edit]($input$)"
# ---

# Rebuild options:
# - "newfile": Build only if .html doesn't exist
# - "outdated": Rebuild if .html is older than source
# - 0 (numeric): Always rebuild all files
```
```

--------------------------------

### Execute litedown::fuse

Source: https://github.com/yihui/litedown/blob/main/site/playground/index.html

Writes editor content to the virtual filesystem and executes litedown::fuse() to render the output in the preview frame.

```javascript
async function run() { if (running || !webR) return; running = true; runBtn.disabled = true; setStatus('Running…'); previewFrame.style.opacity = '.25'; document.body.style.cursor = 'wait'; const t0 = performance.now(); const fileName = sel.value || '_playground.Rmd'; const tmpFile = '/tmp/' + fileName; try { // Write source to the webR virtual filesystem await shelter.captureR( 'writeLines(text, con = file)', { env: { text: editor.getValue(), file: tmpFile } } ); // fuse() handles both .R and .Rmd inputs. // setwd("/tmp") so plot files land there and litedown base64-encodes them. const result = await shelter.captureR( 'setwd("/tmp"); litedown::fuse(file, output = structure(NA, full = TRUE), quiet = TRUE)', { env: { file: tmpFile } } ); const html = (await result.result.toArray()).join('\n'); const doc = previewFrame.contentDocument || previewFrame.contentWindow.document; doc.open(); doc.write(html); doc.close(); const secs = ((performance.now() - t0) / 1000).toFixed(1); setStatus(`Done in ${secs}s`); } catch (e) { console.error('Run error:', e); setStatus('Error — see preview for details'); const errHtml = [ '<html><body style="font-family:system-ui;padding:20px">', '<h3 style="color:#c00">Error</h3>', '<pre style="white-space:pre-wrap">' + escapeHtml(String(e)) + '</pre>', '</body></html>' ].join(''); const doc = previewFrame.contentDocument || previewFrame.contentWindow.document; doc.open(); doc.write(errHtml); doc.close(); } finally { running = false; runBtn.disabled = false; previewFrame.style.opacity = ''; document.body.style.cursor = ''; } }
```

--------------------------------

### Render Raw Code Chunk within Markdown

Source: https://github.com/yihui/litedown/blob/main/examples/test-options.md

Renders a raw code chunk within a markdown document. This is useful for including code examples that should not be processed by the markdown parser itself.

```r
mark('````\nA _code chunk_:

```{r, echo=TRUE}
1 + 1;
```
````')
```

```html
<pre><code>A _code chunk_:

```{r, echo=TRUE}
1 + 1;
```
</code></pre>
```

--------------------------------

### Process raw blocks

Source: https://github.com/yihui/litedown/blob/main/examples/test-options.md

Demonstrates how to handle raw HTML or LaTeX blocks within markdown.

```r
mark('```{=html}
<p>raw HTML</p>
```')
```

```r
mark('```{=latex}
\textbf{raw LaTeX}
```')
```

--------------------------------

### R Code Chunk in a Callout

Source: https://github.com/yihui/litedown/blob/main/examples/003-attr-callout.md

Example of an R code chunk embedded within a callout. The output of the code is also displayed. Ensure `callout` CSS/JS assets are loaded.

```r
1 + 1
```

```text
#> [1] 2
```

--------------------------------

### Define R code template and variables

Source: https://github.com/yihui/litedown/blob/main/examples/005-option-code.md

Define an R template string for a linear model summary and extract variable names for regression. This setup is useful for iterating through multiple predictors.

```r
tpl    = 'lm(mpg ~ %s, data = mtcars) |> summary() |> coef()'
x_vars = names(mtcars)[2:4]
```

--------------------------------

### Playground JavaScript Logic

Source: https://github.com/yihui/litedown/blob/main/site/playground/index.html

Handles UI interactions, CodeMirror editor initialization, and file fetching for the playground.

```javascript
// --------------------------------------------------------------------------- // UI references // --------------------------------------------------------------------------- const runBtn = document.getElementById('run-btn'); const statusEl = document.getElementById('status'); const overlay = document.getElementById('loading-overlay'); const loadingMsg = document.getElementById('loading-msg'); const previewFrame = document.getElementById('preview-frame'); const sel = document.getElementById('examples-select'); const setStatus = (msg) => { statusEl.textContent = msg; }; const setLoading = (msg) => { loadingMsg.textContent = msg; }; const escapeHtml = (s) => s.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;'); // --------------------------------------------------------------------------- // CodeMirror 5 editor (global `CodeMirror` injected by the <script> tags above) // --------------------------------------------------------------------------- // Register {r} as a MIME alias so fenced ```{r} blocks get R syntax highlighting CodeMirror.defineMIME('text/{r}', 'text/x-rsrc'); const rmdMode = { name: 'markdown', fencedCodeBlockHighlighting: true, highlightFormatting: true }; const rMode = 'text/x-rsrc'; const editor = CodeMirror(document.getElementById('editor-wrap'), { value: '', mode: rmdMode, lineNumbers: true, lineWrapping: true, extraKeys: { 'Ctrl-Shift-Enter': () => run(), 'Cmd-Shift-Enter': () => run(), }, }); function setEditorMode(file) { const isR = /\.R$/i.test(file) && !/\.Rmd$/i.test(file); editor.setOption('mode', isR ? rMode : rmdMode); } // --------------------------------------------------------------------------- // Default content — fetch _default.Rmd or _default.R from playground dir // --------------------------------------------------------------------------- async function loadDefault() { for (const file of ['_default.Rmd', '_default.R']) { try { const res = await fetch('./' + file); if (!res.ok) continue; const text = await res.text(); sel.options[0].value = file; sel.value = file; setEditorMode(file); editor.setValue(text.trimStart()); return; } catch (_) {} } // Fallback: empty editor in Rmd mode editor.setOption('mode', rmdMode); editor.setValue(''); } // --------------------------------------------------------------------------- // Examples dropdown — numbered examples appended from examples.txt when // available (generated by the GitHub Actions workflow). // --------------------------------------------------------------------------- sel.addEventListener('change', async () => { if (sel.selectedIndex === 0) { await loadDefault(); return; } try { const r = await fetch('../examples/' + sel.value); if (!r.ok) throw new Error(r.statusText); setEdit
```

--------------------------------

### Prepare Sunspot Data

Source: https://github.com/yihui/litedown/blob/main/examples/022-dygraphs.md

Format the yearly sunspot data for visualization.

```r
sunspot = cbind(Year = time(sunspot.year), Sunspots = sunspot.year)
```

--------------------------------

### Run R regression with 'cyl' variable

Source: https://github.com/yihui/litedown/blob/main/examples/005-option-code.md

Executes an R linear regression of 'mpg' on 'cyl' using the mtcars dataset and displays the coefficient summary. This is an example of running a specific regression defined by the template.

```r
lm(mpg ~ cyl, data = mtcars) |> summary() |> coef()
```

--------------------------------

### Run R regression with 'hp' variable

Source: https://github.com/yihui/litedown/blob/main/examples/005-option-code.md

Executes an R linear regression of 'mpg' on 'hp' using the mtcars dataset and displays the coefficient summary. This shows the final example of running the regression template with another predictor.

```r
lm(mpg ~ hp, data = mtcars) |> summary() |> coef()
```

--------------------------------

### Import Chart.js Library

Source: https://github.com/yihui/litedown/blob/main/examples/024-chart-js.md

Use the litedown::vest function to import the Chart.js library from npm. This is required before drawing any charts.

```r
litedown::vest(js = '@npm/chart.js')
```

--------------------------------

### Control Markdown Rendering Options with litedown

Source: https://context7.com/yihui/litedown/llms.txt

List available markdown rendering options and apply them using `mark()`. Options can be enabled with '+' or disabled with '-'. Use a list for multiple options.

```r
litedown::markdown_options()
#>  [1] "+auto_identifiers" "+autolink"        "+cross_refs"
#>  [4] "+embed_cleanup"    "+embed_resources" "+footnotes"
#>  [7] "+js_highlight"     "+js_math"         "+latex_math"
#> [10] "+smart"            "+strikethrough"   "+subscript"
#> [13] "+superscript"      "+table"           "+tagfilter"
#> [16] "-cleveref"         "-hardbreaks"      "-number_sections"
#> [19] "-offline"          "-smartypants"     "-toc"
```

```r
mark("# Heading\n\nText", options = "+toc +number_sections")
```

```r
mark("1st -- 2nd", options = "+smartypants")  # Smart quotes/dashes
```

```r
mark("x^2^ and H~2~O", options = "+superscript +subscript")
```

```r
mark("$E = mc^2$", options = "+latex_math")
```

```r
mark("Text", options = list(toc = TRUE, number_sections = TRUE))
```

--------------------------------

### Generate Package Documentation with litedown Helpers

Source: https://context7.com/yihui/litedown/llms.txt

Helper functions like `pkg_desc()`, `pkg_news()`, `pkg_citation()`, `pkg_manual()`, and `pkg_code()` can be used in R Markdown to generate package documentation similar to pkgdown.

```r
# Generate package DESCRIPTION as HTML table
# litedown::pkg_desc()
```

```r
# Generate NEWS/changelog
# litedown::pkg_news()                  # Latest version only
# litedown::pkg_news(recent = 0)        # Full changelog
# litedown::pkg_news(recent = 3)        # Last 3 versions
```

```r
# Generate citation information
# litedown::pkg_citation()
```

```r
# Generate manual pages as HTML
# litedown::pkg_manual()
```

```r
# Generate source code listing
# litedown::pkg_code()
```
Tokens:
Raw