Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ArthurData/quarto-confetti
Send some 🎊
https://github.com/ArthurData/quarto-confetti
canvas-confetti quarto quarto-extension
Last synced: 3 months ago
JSON representation
Send some 🎊
- Host: GitHub
- URL: https://github.com/ArthurData/quarto-confetti
- Owner: ArthurData
- License: mit
- Created: 2022-11-25T15:49:47.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-16T17:46:25.000Z (over 1 year ago)
- Last Synced: 2024-05-08T08:31:30.967Z (6 months ago)
- Topics: canvas-confetti, quarto, quarto-extension
- Language: JavaScript
- Homepage: https://ArthurData.github.io/quarto-confetti/
- Size: 10.5 MB
- Stars: 17
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Confetti Extension For Quarto
Send some 🎊 confetti 🎊 through your presentation.
This extension uses a JavaScript library called: **[canvas-confetti](https://github.com/catdad/canvas-confetti)**.
## Installation
To install this extension:
```
quarto add ArthurData/quarto-confetti
```
> Requires Quarto Version 1.2.269 or later...
## Usage
First, create a project for your presentation:
```
quarto create-project prezwithconfetti
cd prezwithconfetti
```
Add this extension to the project:
```
quarto add ArthurData/quarto-confetti
```
Then, modify the YAML header of your presentation:
```
---
title: "My presentation"
format:
revealjs: default
revealjs-plugins:
- confetti
---
```
This will activate the confetti extension in your revealjs presentation with **default parameters**.
You can also personalise your confetti:
```
---
title: "My presentation"
format:
revealjs:
confetti:
particleCount: 150
angle: 90
spread: 360
startVelocity: 25
gravity: 0.65
drift: 0
ticks: 400
colors: ["#0366fc", "#f54281", "#1fd14f"]
scalar: 0.7
revealjs-plugins:
- confetti
---
```
## Options
More details about the options are available here: [canvas-confetti](https://github.com/catdad/canvas-confetti#options)
## Example
Use the `c` to send some 🎊🎊
View an example: [https://ArthurData.github.io/quarto-confetti/](https://ArthurData.github.io/quarto-confetti/)