Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mcanouil/quarto-animate
Animate.css extension for Quarto
https://github.com/mcanouil/quarto-animate
animatecss animation css quarto quarto-extension quarto-pub quartopub
Last synced: about 1 month ago
JSON representation
Animate.css extension for Quarto
- Host: GitHub
- URL: https://github.com/mcanouil/quarto-animate
- Owner: mcanouil
- License: mit
- Created: 2022-09-03T16:11:14.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-20T11:46:40.000Z (5 months ago)
- Last Synced: 2024-11-18T05:38:39.048Z (about 1 month ago)
- Topics: animatecss, animation, css, quarto, quarto-extension, quarto-pub, quartopub
- Language: Lua
- Homepage: https://m.canouil.dev/quarto-animate/
- Size: 46.9 KB
- Stars: 41
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Animate.css Extension for Quarto
This extension provides support and shortcode to [animate.css](https://animate.style/).
Animations are only available for HTML-based documents.
## Installing
```sh
quarto add mcanouil/quarto-animate
```
This will install the extension under the `_extensions` subdirectory.
If you're using version control, you will want to check in this directory.
## Using
To animate a text, use the `{{< animate >}}` shortcode. For example:
```markdown
{{< animate bounce "Some text" >}}
```
- Mandatory `` and ``:
``` markdown
{{< animate "" >}}
```
- Optional ``, ``, and ``:
``` markdown
{{< animate "" >}}
```
`` and `` are durations requiring unit, _e.g._, `1s` or `800ms`.
See for more details.
## Animation effects
- __Attention seekers__:
`bounce`, `flash`, `pulse`, `rubberBand`, `shakeX`, `shakeY`, `headShake`, `swing`, `tada`, `wobble`, `jello`, `heartBeat`.
- __Back entrances__:
`backInDown`, `backInLeft`, `backInRight`, `backInUp`.
- __Back exits__:
`backOutDown`, `backOutLeft`, `backOutRight`, `backOutUp`.
- __Bouncing entrances__:
`bounceIn`, `bounceInDown`, `bounceInLeft`, `bounceInRight`, `bounceInUp`.
- __Bouncing exits__:
`bounceOut`, `bounceOutDown`, `bounceOutLeft`, `bounceOutRight`, `bounceOutUp`.
- __Fading entrances__:
`fadeIn`, `fadeInDown`, `fadeInDownBig`, `fadeInLeft`, `fadeInLeftBig`, `fadeInRight`, `fadeInRightBig`, `fadeInUp`, `fadeInUpBig`, `fadeInTopLeft`, `fadeInTopRight`, `fadeInBottomLeft`, `fadeInBottomRight`.
- __Fading exits__:
`fadeOut`, `fadeOutDown`, `fadeOutDownBig`, `fadeOutLeft`, `fadeOutLeftBig`, `fadeOutRight`, `fadeOutRightBig`, `fadeOutUp`, `fadeOutUpBig`, `fadeOutTopLeft`, `fadeOutTopRight`, `fadeOutBottomRight`, `fadeOutBottomLeft`.
- __Flippers__:
`flip`, `flipInX`, `flipInY`, `flipOutX`, `flipOutY`.
- __Lightspeed__:
`lightSpeedInRight`, `lightSpeedInLeft`, `lightSpeedOutRight`, `lightSpeedOutLeft`.
- __Rotating entrances__:
`rotateIn`, `rotateInDownLeft`, `rotateInDownRight`, `rotateInUpLeft`, `rotateInUpRight`.
- __Rotating exits__:
`rotateOut`, `rotateOutDownLeft`, `rotateOutDownRight`, `rotateOutUpLeft`, `rotateOutUpRight`.
- __Specials__:
`hinge`, `jackInTheBox`, `rollIn`, `rollOut`.
- __Zooming entrances__:
`zoomIn`, `zoomInDown`, `zoomInLeft`, `zoomInRight`, `zoomInUp`.
- __Zooming exits__:
`zoomOut`, `zoomOutDown`, `zoomOutLeft`, `zoomOutRight`, `zoomOutUp`.
- __Sliding entrances__:
`slideInDown`, `slideInLeft`, `slideInRight`, `slideInUp`.
- __Sliding exits__:
`slideOutDown`, `slideOutLeft`, `slideOutRight`, `slideOutUp`.
## Advanced
The following won't work:
```markdown
{{< animate bounce "[HTML](https://m.canouil.dev/quarto-animate/)" >}}
```
But this will:
```markdown
[[HTML](https://m.canouil.dev/quarto-animate/)]{.animate__animated .animate__bounce style="display:inline-block;"}
```
Or:
```markdown
::: {.animate__animated .animate__bounce}
[HTML](https://m.canouil.dev/quarto-animate/)
:::
```
See for more details.
## Example
Here is the source code for a minimal example: [example.qmd](example.qmd).
This is the output of `example.qmd` for [HTML](https://m.canouil.dev/quarto-animate/).
---
[Animate.css](https://animate.style/) by Daniel Eden under Hippocratic License 3.0.