Skip to content

Commit ebbe675

Browse files
committed
Authoring notes
1 parent 1f4ee04 commit ebbe675

File tree

2 files changed

+35
-2
lines changed

2 files changed

+35
-2
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,29 @@ This repository contains a code powering the "Next-Generation Data Science Educa
66

77
To create your own version of the demonstration, you need to install the following software:
88

9+
- RStudio IDE, VS Code, Positron, or another text editor
10+
- For VS Code or Positron, please install the [Quarto plugin](https://open-vsx.org/extension/quarto/quarto).
911
- [Quarto](https://quarto.org) v1.4.0 or later
1012
- Quarto Extensions
1113
- [`quarto-live`](https://r-wasm.github.io/quarto-live/)
1214
- [`quarto-drop`](https://github.com/r-wasm/quarto-drop)
1315
- [`quarto-countdown`](https://github.com/gadenbuie/countdown/tree/main/quarto)
16+
- [`quarto-embedio`](https://github.com/coatless-quarto/embedio)
1417

15-
You can do this by typing the following commands in your terminal:
18+
You can install the Quarto Extensions by typing the following commands in your terminal:
1619

1720
```bash
1821
quarto add r-wasm/quarto-live
1922
quarto add r-wasm/quarto-drop
2023
quarto add gadenbuie/countdown/quarto
24+
quarto add coatless-quarto/embedio
2125
```
26+
27+
## GitHub Pages
28+
29+
The demonstration is hosted on GitHub Pages using a GitHub Action ([`publish-website.yml`](.github/workflows/publish-website.yml)). The action is triggered on every push to the `main` branch. The action builds the Quarto website and pushes the output to the `gh-pages`.
30+
31+
Please make sure to enable GitHub Pages in the repository settings, select the GitHub Actions as the source,
32+
and check the **Enforce HTTPS** option.
33+
34+
<img width="1362" alt="Setup GitHub Pages for Deploying `quarto-live`" src="https://github.com/user-attachments/assets/5c47f7a6-64ba-45f2-b3cf-2303fb801579">

index.qmd

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,29 @@ To explore this demo:
6060

6161
### Authoring
6262

63-
To create interactive presentations like this, you'll need to use Quarto with the `quarto-live` backend. Please make sure you have at least Quarto v1.4.0 or later installed. You may need to install additional packages for R and Python support.
63+
To create your own version of the demonstration, you need to install the following software:
64+
65+
- RStudio IDE, VS Code, Positron, or another text editor
66+
- For VS Code or Positron, please install the [Quarto plugin](https://open-vsx.org/extension/quarto/quarto).
67+
- [Quarto](https://quarto.org) v1.4.0 or later
68+
- Quarto Extensions
69+
- [`quarto-live`](https://r-wasm.github.io/quarto-live/)
70+
- [`quarto-drop`](https://github.com/r-wasm/quarto-drop)
71+
- [`quarto-countdown`](https://github.com/gadenbuie/countdown/tree/main/quarto)
72+
- [`quarto-embedio`](https://github.com/coatless-quarto/embedio)
73+
74+
You can install the Quarto Extensions by typing the following commands in your terminal:
75+
76+
```bash
77+
quarto add r-wasm/quarto-live
78+
quarto add r-wasm/quarto-drop
79+
quarto add gadenbuie/countdown/quarto
80+
quarto add coatless-quarto/embedio
81+
```
6482

6583

6684
## Feedback and Questions
6785

86+
Question or comments? Let me know either on the issue tracker or via socials.
87+
6888
Enjoy exploring the future of interactive data science presentations!

0 commit comments

Comments
 (0)