https://github.com/EmilHvitfeldt/quarto-roughnotation

An extension that uses the roughnotation javascript library to add animated annotations to revealjs documents.
https://github.com/EmilHvitfeldt/quarto-roughnotation

quarto quarto-extension quarto-pub quartopub

Last synced: 2 months ago
JSON representation

An extension that uses the roughnotation javascript library to add animated annotations to revealjs documents.

• Host: GitHub
• URL: https://github.com/EmilHvitfeldt/quarto-roughnotation
• Owner: EmilHvitfeldt
• Created: 2022-09-08T04:56:55.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-09-27T18:54:18.000Z (over 1 year ago)
• Last Synced: 2024-11-13T23:33:10.572Z (2 months ago)
• Topics: quarto, quarto-extension, quarto-pub, quartopub
• Language: JavaScript
• Homepage: https://emilhvitfeldt.github.io/quarto-roughnotation/
• Size: 2.05 MB
• Stars: 62
• Watchers: 3
• Forks: 3
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# roughnotation

An extension that uses the [roughnotation](https://roughnotation.com/) javascript library to add animated annotations to revealjs documents.

## Installation

To install this extension in your current directory (or into the Quarto project that you're currently working in), use the following command:

``` bash

quarto install extension EmilHvitfeldt/quarto-roughnotation

```

## Usage

The roughnotation extension is implemented as a filter in Quarto. Once installed, using the extension is easy.

### Setup

You can enable this like:

``` markdown

---

title: Simple roughnotation setup

filters:

   - roughnotation

---

```

Then use the `.rn` to class to specify what elements should be highlighted.

``` markdown

[Highlight me!]{.rn}

```

Lastly, press the `R` key to activate the animation. For more examples and options look at the examples [here](https://Emilhvitfeldt.github.io/quarto-roughnotation/).

## Example

Here is the source code for many of the examples: [example.qmd](https://github.com/EmilHvitfeldt/quarto-roughnotation/blob/main/example.qmd)

This is the output of [example.qmd](https://Emilhvitfeldt.github.io/quarto-roughnotation/).