Allow pdf and revealjs use a non-named argument. Add options to docum…

…entation.
coatless-quarto · Feb 15, 2024 · b80b43b · b80b43b
1 parent a78fa91
commit b80b43b
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 2 deletions.
diff --git a/_extensions/embedio/pdf.lua b/_extensions/embedio/pdf.lua
@@ -5,7 +5,9 @@ local function pdf(args, kwargs, meta)
   end
 
   -- Supported options for now
-  local pdf_file_name = pandoc.utils.stringify(kwargs["file"])
+  local pdf_file_name = args[1] or kwargs["file"]
+  pdf_file_name = pandoc.utils.stringify(pdf_file_name)
+
   local height = pandoc.utils.stringify(kwargs["height"]) or "600px"
   local width = pandoc.utils.stringify(kwargs["height"]) or "100%"
 

diff --git a/_extensions/embedio/revealjs.lua b/_extensions/embedio/revealjs.lua
@@ -34,7 +34,8 @@ local function revealjs(args, kwargs, meta , raw_args)
   ensureSlideCSSPresent()
 
   -- Supported options for now
-  local slide_file_name = pandoc.utils.stringify(kwargs["file"])
+  local slide_file_name = args[1] or kwargs["file"]
+  slide_file_name = pandoc.utils.stringify(slide_file_name)
   local height = pandoc.utils.stringify(kwargs["height"]) or "475px"
 
   -- HTML block

diff --git a/docs/qembedio-embed-pdf.qmd b/docs/qembedio-embed-pdf.qmd
@@ -12,3 +12,12 @@ For example, we can show the `test.pdf` with:
 
 {{< pdf file="assets/test.pdf" >}}
 
+## Options
+
+| Keyword Argument | Default Value | Description                                              |
+|-------------------|---------------|----------------------------------------------------------|
+| `file`            | None          | Specifies the input PDF file path.                       |
+| `height`          | "600px"       | Specifies the height of the embedded PDF object.         |
+| `width`           | "100%"        | Specifies the width of the embedded PDF object.          |
+
+You may also omit specifying a `file` option. We'll automatically use the first parameter as the `file`
diff --git a/docs/qembedio-embed-revealjs.qmd b/docs/qembedio-embed-revealjs.qmd
@@ -12,3 +12,11 @@ For example, we can show the `slides-reveal.html` with:
 
 {{< revealjs file="assets/slides-reveal.html" >}}
 
+## Options
+
+| Keyword Argument | Default Value | Description                                              |
+|-------------------|---------------|----------------------------------------------------------|
+| `file`            | None          | Specifies the input file path for the Reveal.js slides.  |
+| `height`          | "475px"       | Specifies the height of the embedded slide deck.         |
+
+You may also omit specifying a `file` option. We'll automatically use the first parameter as the `file`