Skip to content

Commit

Permalink
Update README and GHA deployment
Browse files Browse the repository at this point in the history
  • Loading branch information
georgestagg committed Jul 22, 2024
1 parent e2a9146 commit 79bd805
Show file tree
Hide file tree
Showing 5 changed files with 56 additions and 1 deletion.
40 changes: 40 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
on:
push:
branches:
- main

name: Render and Publish
jobs:
build-deploy:
runs-on: ubuntu-latest
permissions:
contents: write
pages: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Check out repository
uses: actions/checkout@v4
- name: Setup NodeJS
uses: actions/setup-node@v4
with:
node-version: 20
- name: Set up Quarto
uses: quarto-dev/quarto-actions/setup@v2
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: '3.12'
- name: Install Jupyter
run: python3 -m pip install jupyter
- name: Setup R
uses: r-lib/actions/setup-r@v2
- name: Install R packages
run: Rscript -e 'install.packages(c("rmarkdown", "knitr"))'
- name: Render Quarto Project
uses: quarto-dev/quarto-actions/publish@v2
with:
target: gh-pages
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
node_modules
example.html
example_files
example_site

/.quarto/
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@

Have you ever given a talk or presentation and wanted an R or Python console *right there* in your slides for some quick throwaway examples or demos? Do you find switching to another window or desktop so that you can show some work in an IDE fiddly and distracting?

Then this plugin is for you. With Quarto Drop, you can press a shortcut key to immediately drop down from the top of the slide an interactive R or Python console, editor and plotting window. The same shortcut key then dismisses the console.
If so, this plugin is for you! With Quarto Drop, you can press a shortcut key to immediately drop down from the top of the slide an interactive R or Python console, editor and plotting window. The same shortcut key then dismisses the console.

Show your demo then dismiss the console. Later, on another slide, you can drop it down again and state is maintained over multiple slides.


Code execution is powered by WebAssembly, using [webR](https://docs.r-wasm.org) and [Pyodide](https://pyodide.org). No R or Python execution servers are required.

## Usage
Expand All @@ -28,6 +29,12 @@ revealjs-plugins:

3. During the presentation, press the drop shortcut. By default, it is the backtick key: "`". Alternatively, press the console button at the bottom left of the slide.

## Demo

![](https://github.com/r-wasm/quarto-drop/raw/main/images/drop.gif)

Example slides: https://r-wasm.github.io/quarto-drop/

## Configuration

#### Change the shortcut key and console button visibility:
Expand Down
5 changes: 5 additions & 0 deletions _quarto.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
project:
type: website
render:
- example.qmd
output-dir: example_site
Binary file added images/drop.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 79bd805

Please sign in to comment.