Fix embedded source files not copied when rendering (#16)

* Register embedded files as Quarto resources automatically

Adds ensureResource() to resolve local file paths relative to the
input document and call quarto.doc.add_resource(), so referenced
files are copied to the output directory without manual YAML config.

* Update FAQ to note automatic resource handling

* Add audio to FAQ resource example and link shortcode pages to troubleshooting

* Handle empty paths and strip query/fragment from resource paths

Author: coatless

_extensions/embedio/embedio.lua

@@ -42,6 +42,34 @@ local function checkFile(input)
   end
 end
 
+-- Check if a path is a remote reference (URL, data URI, or anchor)
+local function isRemoteRef(path)
+  return path:find("^%a+://") ~= nil or
+         path:find("^data:") ~= nil or
+         path:find("^#") ~= nil
+end
+
+-- Register a local file as a Quarto resource so it is copied to the output
+local function ensureResource(file_path)
+  if isVariableEmpty(file_path) or isRemoteRef(file_path) then
+    return
+  end
+
+  -- Strip query strings and fragments (e.g. audio.mp3#t=10)
+  local resource_path = file_path:match("^[^%?#]+") or file_path
+
+  -- Resolve to an absolute path based on the input document's directory
+  local abs_path
+  if pandoc.path.is_absolute(resource_path) then
+    abs_path = resource_path
+  else
+    local doc_dir = pandoc.path.directory(quarto.doc.input_file)
+    abs_path = pandoc.path.normalize(pandoc.path.join({doc_dir, resource_path}))
+  end
+
+  quarto.doc.add_resource(abs_path)
+end
+
 -- Avoid duplicate class definitions
 local initializedSlideCSS = false
 
@@ -104,6 +132,9 @@ local function html(args, kwargs, meta, raw_args)
   local full_screen_link = getOption(kwargs, "full-screen-link", "true")
   local class = getOption(kwargs, "class", "")
 
+  -- Ensure file is copied to the output directory
+  ensureResource(file_name)
+
   -- Define the template for embedding HTML files
   local template_html = [[
     <div%s>
@@ -130,6 +161,9 @@ local function revealjs(args, kwargs, meta, raw_args)
   local full_screen_link = getOption(kwargs, "full-screen-link", "true")
   local class = getOption(kwargs, "class", "")
 
+  -- Ensure file is copied to the output directory
+  ensureResource(file_name)
+
   -- Define the template for embedding Reveal.js slides
   local template_revealjs = [[
     <div%s>
@@ -157,6 +191,9 @@ local function audio(args, kwargs, meta)
   local input = pandoc.utils.stringify(args[1] or kwargs.file)
   checkFile(input)
 
+  -- Ensure file is copied to the output directory
+  ensureResource(input)
+
   -- Add class attribute if provided
   if class then
       table.insert(htmlTable, 'class="' .. class .. '">')
@@ -208,7 +245,10 @@ local function pdf(args, kwargs, meta)
   -- Supported options for now
   local pdf_file_name = pandoc.utils.stringify(args[1] or kwargs["file"])
   checkFile(pdf_file_name)
-  
+
+  -- Ensure file is copied to the output directory
+  ensureResource(pdf_file_name)
+
   local height = getOption(kwargs, "height", "600px")
   local width = getOption(kwargs, "width", "100%")
   local download_link = getOption(kwargs, "download-link", "true")

docs/qembedio-embed-audio.qmd

@@ -21,4 +21,8 @@ For example, the above shortcode embeds the `my-audio.mp3` in `assets/`  as:
 | `class`          | `""`          | Specifies the class attribute for the figure element. |
 | `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`
+You may also omit specifying a `file` option. We'll automatically use the first parameter as the `file`
+
+:::{.callout-tip}
+Having trouble with files not appearing in the rendered output? See the [troubleshooting section](qembedio-faq.qmd#im-encountering-issues-with-embedding-files.-what-should-i-do) of the FAQ.
+:::

docs/qembedio-embed-html.qmd

@@ -22,4 +22,8 @@ For example, the above shortcode embeds the `my-html-page.html` in `assets/` as:
 | `full-screen-link`    | "true"        | Add a link to view the embedded webpage in a new full screen browser window.         |
 | `class`          | None          | Specifies the classes of the container wrapping the embedded webpage. |
 
-You may also omit specifying a `file` option. We'll automatically use the first parameter as the `file`
+You may also omit specifying a `file` option. We'll automatically use the first parameter as the `file`
+
+:::{.callout-tip}
+Having trouble with files not appearing in the rendered output? See the [troubleshooting section](qembedio-faq.qmd#im-encountering-issues-with-embedding-files.-what-should-i-do) of the FAQ.
+:::

docs/qembedio-embed-pdf.qmd

@@ -21,4 +21,8 @@ For example, the above shortcode embeds the `my-pdf-file.pdf` in `assets/` as:
 | `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`
+You may also omit specifying a `file` option. We'll automatically use the first parameter as the `file`
+
+:::{.callout-tip}
+Having trouble with files not appearing in the rendered output? See the [troubleshooting section](qembedio-faq.qmd#im-encountering-issues-with-embedding-files.-what-should-i-do) of the FAQ.
+:::

docs/qembedio-embed-revealjs.qmd

@@ -22,4 +22,8 @@ For example, the above shortcode embeds the `my-revealjs-slides.html` in `assets
 | `full-screen-link`    | "true"        | Add a link to view the embedded slide deck in a new full screen browser window.         |
 | `class`          | None          | Specifies the classes of the container wrapping the embedded slide deck.          |
 
-You may also omit specifying a `file` option. We'll automatically use the first parameter as the `file`
+You may also omit specifying a `file` option. We'll automatically use the first parameter as the `file`
+
+:::{.callout-tip}
+Having trouble with files not appearing in the rendered output? See the [troubleshooting section](qembedio-faq.qmd#im-encountering-issues-with-embedding-files.-what-should-i-do) of the FAQ.
+:::

docs/qembedio-faq.qmd

@@ -52,15 +52,18 @@ For more details, please see [Demo: RevealJS](qembedio-embed-revealjs.qmd).
 
 If you're experiencing difficulties with file embedding, first ensure that your Quarto project has the `embedio` shortcode extension installed by looking in the `_extensions` folder. 
 
-Next, make sure that the resource is specified in the `resources` key under the publishing format: 
+Starting with v0.0.3, the `embedio` shortcodes automatically register embedded files as Quarto resources, so they are copied to the output directory without any extra configuration.
+
+If you are using an older version of the extension (or need to include files that are _not_ referenced by a shortcode), you can manually declare them in the `resources` key under the publishing format:
 
 ```yaml
 ---
 title: Example resource inclusion
 format:
-  html: 
-    resources: 
+  html:
+    resources:
     - path/to/file.pdf
+    - path/to/audio.mp3
 ---
 ```