Skip to content

Commit

Permalink
Authoring notes
Browse files Browse the repository at this point in the history
  • Loading branch information
coatless committed Aug 10, 2024
1 parent 1f4ee04 commit ebbe675
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 2 deletions.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,29 @@ This repository contains a code powering the "Next-Generation Data Science Educa

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

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

You can do this by typing the following commands in your terminal:
You can install the Quarto Extensions by typing the following commands in your terminal:

```bash
quarto add r-wasm/quarto-live
quarto add r-wasm/quarto-drop
quarto add gadenbuie/countdown/quarto
quarto add coatless-quarto/embedio
```

## GitHub Pages

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`.

Please make sure to enable GitHub Pages in the repository settings, select the GitHub Actions as the source,
and check the **Enforce HTTPS** option.

<img width="1362" alt="Setup GitHub Pages for Deploying `quarto-live`" src="https://github.com/user-attachments/assets/5c47f7a6-64ba-45f2-b3cf-2303fb801579">
22 changes: 21 additions & 1 deletion index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,29 @@ To explore this demo:

### Authoring

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.
To create your own version of the demonstration, you need to install the following software:

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

You can install the Quarto Extensions by typing the following commands in your terminal:

```bash
quarto add r-wasm/quarto-live
quarto add r-wasm/quarto-drop
quarto add gadenbuie/countdown/quarto
quarto add coatless-quarto/embedio
```


## Feedback and Questions

Question or comments? Let me know either on the issue tracker or via socials.

Enjoy exploring the future of interactive data science presentations!

0 comments on commit ebbe675

Please sign in to comment.