Skip to content

Commit

Permalink
Add some usage notes
Browse files Browse the repository at this point in the history
  • Loading branch information
coatless committed Feb 24, 2024
1 parent b80b43b commit 88f73a5
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,29 @@ This command will download and install the shortcode extension under the `_exten

## Usage

Add more details
We presently support the following shortcodes:

| Shortcode | Description |
|------------|-----------------------------------------------------------------|
| `audio` | Embeds an audio player with optional caption and download link. |
| `pdf` | Embeds a PDF file with customizable width and height. |
| `revealjs` | Embeds a Reveal.js slide deck with optional height. |

You can use the shortcode immediately in a Quarto project that has the extension installed by typing into the document:

```md
{{< shortcode-name filename >}}
```

For example, we can embed RevealJS slides using:

```md
{{< revealjs "assets/my-slides.html" >}}
```

## Help

To report a bug, please [add an issue](https://github.com/coatless-quarto/embedio/issues/new) to the repository's [bug tracker](https://github.com/coatless-quarto/embedio/issues).

Want to contribute a feature? Please open an issue ticket to discuss the feature before sending a pull request.

0 comments on commit 88f73a5

Please sign in to comment.