What's the correct way to add html/site assets via an extension?

[astroDimitrios]

Description

I'm making an extension and adding css works fine via the css: yml entry but what is the correct way of adding images, favicons, js?

If I use format-resources then folders with my assets appear to be copied into every directory where I've specified .md files to render which means lots of duplication of images and javascript. Is there a way to copy them as site wide assets via the extension?

My current _extension.yml and an example website repo structure where there are files to render in episodes, instructors, learners etc.

[mcanouil]

If I use format-resources' then folders with my assets appear to be copied into every directory where I've specified .md` files to render which means lots of duplication of images and javascript.

Did you read the documentation on creating extensions?
https://quarto.org/docs/extensions/formats.html#format-resources

Is there a way to copy them as site wide assets via the extension?

Again, I am directing you to the documentation: https://quarto.org/docs/extensions/lua-api.html

[astroDimitrios]

Ok thanks :) - so it looks like I need the Quarto Lua API (quarto.doc.add_html_dependency()). Is it worth adding anything to this section of the docs along the lines of: this call allows you to add site wide resources to the site_libs directory, and perhaps something about the directory structure of added resources?

For instance I added:

quarto.doc.add_html_dependency({
    name = "carpentries-images",
    version = "1.0.0",
    resources = {"images"}
  })

which means I now have access to these images in _site/site_libs/quarto-contrib/carpentries-images-1.0.0/images.

Now just need to work out how to add this path to my metadata with the lua so I don't have to type it out all the time!

[cderv]

You have also quarto.doc.add_format_resource(path) is this is easier to have the resource as part of the project from content shipped inside the extension.

Regarding Path, quarto.utils.resolve_path(path) could be helpful to compute path internally to your extension.