One more pass on demos

coatless-quarto · Apr 23, 2024 · b228db3 · b228db3
1 parent fe4cecd
commit b228db3
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/docs/qembedio-embed-audio.qmd b/docs/qembedio-embed-audio.qmd
@@ -5,12 +5,12 @@ title: "Embed Audio"
 The `audio` short code generates an embedded audio object for HTML websites. You can use it with:
 
 ```markdown
-{{{< audio file="assets/my-audio.mp3" download="true">}}}
+{{{< audio file="assets/my-audio.mp3" caption="Sample Audio File">}}}
 ```
 
-For example, we can embed the `my-audio.mp3` in the `assets/` with:
+For example, the above shortcode embeds the `my-audio.mp3` in `assets/`  with:
 
-{{< audio file="assets/my-audio.mp3" download="true" >}}
+{{< audio file="assets/my-audio.mp3" caption="Sample Audio File" >}}
 
 ## Options
 
@@ -19,6 +19,6 @@ For example, we can embed the `my-audio.mp3` in the `assets/` with:
 | `file`           | `""`          | Specifies the input file path for the audio element.  |
 | `caption`        | `""`          | Specifies the caption for the audio element.          |
 | `class`          | `""`          | Specifies the class attribute for the figure element. |
-| `download`       | `"false"`     | Specifies whether to include a download link.         |
+| `download-link`       | `"false"`     | Specifies whether to include a download link.         |
 
 You may also omit specifying a `file` option. We'll automatically use the first parameter as the `file`
diff --git a/docs/qembedio-embed-pdf.qmd b/docs/qembedio-embed-pdf.qmd
@@ -8,7 +8,7 @@ The `pdf` short code generates an embedded PDF object for HTML websites. You can
 {{{< pdf file="assets/test.pdf"  height="500px">}}}
 ```
 
-For example, we can show the `my-pdf-file.pdf` with:
+For example, the above shortcode embeds the `my-pdf-file.pdf` in `assets/` as:
 
 {{< pdf file="assets/my-pdf-file.pdf" height="500px">}}
 

diff --git a/docs/qembedio-embed-revealjs.qmd b/docs/qembedio-embed-revealjs.qmd
@@ -8,9 +8,9 @@ The `revealjs` short code generates an embedded `<iframe>` area for HTML website
 {{{< revealjs file="assets/my-revealjs-slides.html" height="500px">}}}
 ```
 
-For example, we can show the `my-revealjs-slides.html` with:
+For example, the above shortcode embeds the `my-revealjs-slides.html` in `assets/` as:
 
-{{< revealjs file="assets/my-revealjs-slides.html" height="500px">}}
+{{< revealjs file="assets/my-revealjs-slides.html" height="500px" >}}
 
 ## Options