Skip to content

Commit

Permalink
Add option for download-link to appear above PDF document.
Browse files Browse the repository at this point in the history
  • Loading branch information
coatless committed Apr 23, 2024
1 parent 39f4098 commit 0e1b41e
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/qembedio-embed-pdf.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,20 @@ title: "Embed PDF"
The `pdf` short code generates an embedded PDF object for HTML websites. You can use it with:

```markdown
{{{< pdf file="assets/test.pdf" height="700px">}}}
{{{< pdf file="assets/test.pdf" height="500px">}}}
```

For example, we can show the `my-pdf-file.pdf` with:

{{< pdf file="assets/my-pdf-file.pdf" height="700px">}}
{{< pdf file="assets/my-pdf-file.pdf" height="500px">}}

## Options

| Keyword Argument | Default Value | Description |
|-------------------|---------------|----------------------------------------------------------|
| `file` | None | Specifies the input PDF file path. |
| `height` | "600px" | Specifies the height of the embedded PDF object. |
| `height` | "850px" | Specifies the height of the embedded PDF object. |
| `width` | "100%" | Specifies the width of the embedded PDF object. |
| `download-link` | "true" | Add a link to download the embedded PDF in a new browser window. |

You may also omit specifying a `file` option. We'll automatically use the first parameter as the `file`

0 comments on commit 0e1b41e

Please sign in to comment.