Skip to content

Commit 6852afd

Browse files
shikokuchuoshikokuchuo
committed
Revert vignettes to Rmd - needed for testing
1 parent 90886f6 commit 6852afd

9 files changed

Lines changed: 55 additions & 36 deletions

File tree

‎.github/workflows/R-CMD-check.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ jobs:
4242

4343
- uses: r-lib/actions/setup-r-dependencies@v2
4444
with:
45-
extra-packages: any::rcmdcheck, local::.
45+
extra-packages: any::rcmdcheck
4646
needs: check
4747

4848
- uses: r-lib/actions/check-r-package@v2

‎.gitignore‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ src/Makevars
1111
compile_commands.json
1212
am-build
1313
am-install
14-
/.quarto/
15-
**/*.quarto_ipynb
1614
docs
1715
inst/doc
1816
/doc/

‎DESCRIPTION‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,11 @@ BugReports: https://github.com/posit-dev/automerge-r/issues
2727
Depends:
2828
R (>= 4.2)
2929
Suggests:
30-
quarto,
30+
knitr,
31+
rmarkdown,
3132
testthat (>= 3.0.0)
3233
VignetteBuilder:
33-
quarto
34+
knitr
3435
Config/build/compilation-database: true
3536
Config/Needs/website: tidyverse/tidytemplate
3637
Config/roxygen2/markdown: TRUE

‎vignettes/.gitignore‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,2 @@
11
*.html
22
*.R
3-
/.quarto/
4-
**/*.quarto_ipynb

vignettes/automerge.qmd renamed to vignettes/automerge.Rmd

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,20 @@
11
---
22
title: "Getting Started with automerge"
3+
output: rmarkdown::html_vignette
34
vignette: >
45
%\VignetteIndexEntry{Getting Started with automerge}
5-
%\VignetteEngine{quarto::html}
6+
%\VignetteEngine{knitr::rmarkdown}
67
%\VignetteEncoding{UTF-8}
7-
knitr:
8-
opts_chunk:
9-
collapse: true
10-
comment: "#>"
118
---
129

10+
```{r}
11+
#| include: false
12+
knitr::opts_chunk$set(
13+
collapse = TRUE,
14+
comment = "#>"
15+
)
16+
```
17+
1318
## What is Automerge?
1419

1520
Automerge is a library that enables automatic merging of concurrent changes without conflicts. It's built on the concept of Conflict-free Replicated Data Types (CRDTs), which are data structures designed to be safely replicated across multiple devices and automatically merged.

vignettes/crdt-concepts.qmd renamed to vignettes/crdt-concepts.Rmd

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,20 @@
11
---
22
title: "Understanding CRDTs in Automerge"
3+
output: rmarkdown::html_vignette
34
vignette: >
45
%\VignetteIndexEntry{Understanding CRDTs in Automerge}
5-
%\VignetteEngine{quarto::html}
6+
%\VignetteEngine{knitr::rmarkdown}
67
%\VignetteEncoding{UTF-8}
7-
knitr:
8-
opts_chunk:
9-
collapse: true
10-
comment: "#>"
118
---
129

10+
```{r}
11+
#| include: false
12+
knitr::opts_chunk$set(
13+
collapse = TRUE,
14+
comment = "#>"
15+
)
16+
```
17+
1318
```{r}
1419
#| label: setup
1520
library(automerge)

vignettes/cross-platform.qmd renamed to vignettes/cross-platform.Rmd

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
11
---
22
title: "Cross-Platform Synchronization: JavaScript ↔ R"
3+
output: rmarkdown::html_vignette
34
vignette: >
45
%\VignetteIndexEntry{Cross-Platform Synchronization: JavaScript ↔ R}
5-
%\VignetteEngine{quarto::html}
6+
%\VignetteEngine{knitr::rmarkdown}
67
%\VignetteEncoding{UTF-8}
7-
execute:
8-
eval: false
9-
knitr:
10-
opts_chunk:
11-
collapse: true
12-
comment: "#>"
138
---
149

10+
```{r, include = FALSE}
11+
knitr::opts_chunk$set(
12+
collapse = TRUE,
13+
comment = "#>",
14+
eval = FALSE # Set to FALSE since examples require Node.js and filesystem operations
15+
)
16+
```
17+
1518
## Running the Examples
1619

1720
This vignette includes executable JavaScript and R code examples. To run them:

vignettes/quick-reference.qmd renamed to vignettes/quick-reference.Rmd

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,21 @@
11
---
22
title: "Quick Reference"
3+
output: rmarkdown::html_vignette
34
vignette: >
45
%\VignetteIndexEntry{Quick Reference}
5-
%\VignetteEngine{quarto::html}
6+
%\VignetteEngine{knitr::rmarkdown}
67
%\VignetteEncoding{UTF-8}
7-
execute:
8-
eval: false
9-
knitr:
10-
opts_chunk:
11-
collapse: true
12-
comment: "#>"
138
---
149

10+
```{r}
11+
#| include: false
12+
knitr::opts_chunk$set(
13+
collapse = TRUE,
14+
comment = "#>",
15+
eval = FALSE
16+
)
17+
```
18+
1519
# Automerge R Package Quick Reference
1620

1721
One-page reference for the `automerge` package. See full documentation with `?function_name`.

vignettes/sync-protocol.qmd renamed to vignettes/sync-protocol.Rmd

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,20 @@
11
---
22
title: "Synchronization Protocol"
3+
output: rmarkdown::html_vignette
34
vignette: >
45
%\VignetteIndexEntry{Synchronization Protocol}
5-
%\VignetteEngine{quarto::html}
6+
%\VignetteEngine{knitr::rmarkdown}
67
%\VignetteEncoding{UTF-8}
7-
knitr:
8-
opts_chunk:
9-
collapse: true
10-
comment: "#>"
118
---
129

10+
```{r}
11+
#| include: false
12+
knitr::opts_chunk$set(
13+
collapse = TRUE,
14+
comment = "#>"
15+
)
16+
```
17+
1318
```{r}
1419
#| label: setup
1520
library(automerge)

0 commit comments

Comments
 (0)