https://github.com/mcanouil/quarto-elevator

Elevator.js extension for Quarto
https://github.com/mcanouil/quarto-elevator

elevatorjs quarto quarto-extension quarto-pub quarto-shortcode quartopub

Last synced: 2 months ago
JSON representation

Elevator.js extension for Quarto

• Host: GitHub
• URL: https://github.com/mcanouil/quarto-elevator
• Owner: mcanouil
• License: mit
• Created: 2022-09-12T20:13:16.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-20T11:55:04.000Z (6 months ago)
• Last Synced: 2024-11-18T05:38:40.765Z (2 months ago)
• Topics: elevatorjs, quarto, quarto-extension, quarto-pub, quarto-shortcode, quartopub
• Language: Lua
• Homepage: https://m.canouil.dev/quarto-elevator/
• Size: 5.04 MB
• Stars: 15
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Elevator.js Extension for Quarto

This extension provides support and shortcode to [Elevator.js](https://github.com/tholman/elevator.js).  

Animation is only available for HTML-based documents.

## Installing

```sh

quarto add mcanouil/quarto-elevator

```

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 add an elevator button, use the `{{< elevator >}}` shortcode. For example:

- Mandatory:

  ``` markdown

  {{< elevator >}}

  ```

- Optional ``, ``, and ``:

  ``` markdown

  {{< elevator    >}}

  ```

## 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-elevator/).

---

[BossaBossa](_extensions/elevator/BossaBossa.mp3) by Kevin MacLeod | .  

Music promoted by .

Creative Commons Creative Commons: By Attribution 3.0 License ().

[Elevator.js](https://github.com/tholman/elevator.js) by Tim Holman under MIT License.