Support for static assets copying in web generator for SSG support

[moshams272]

Description:

As doc-kit moves towards SSG, we need to handle static assets like logos, so when any project use doc-kit, like webpack, can have its images.

now, doc-kit don't handle that so the images crash.

Solution:

Add staticDir option in configration file, so doc-kit can enter that file and copy recursively every folders and static assets.

Copying phase will be in file generate.mjs after CSS bundle line.

[avivkeller]

now, doc-kit don't handle that so the images crash.

WDYM? Images (SVGs) can be specified as JSX elements. Static images can be copied with additionalPathsToCopy

[moshams272]

Actually I debugged by putting image in markdown file like that:

![img](./assets/img.png)

Using web tag, and found that is crashed so I think we need to handle this, and after your comment, I saw the object u mentioned and that's actually what I think about.

What do u think

[avivkeller]

and found that is crashed

Can you show the logs of the crash?

[moshams272]

I think I should replace crashed with using alt

[moshams272]

[avivkeller]

Okay, that's not a crash, it's just a missing asset.

The solution here is just to add additionalPagesToCopy support to the web generator, OR just assume that the user has placed all the needed assets in the output from doc-kit.

cc @nodejs/web-infra thoughts?

[AugustinMauroy]

IMO have a static dir that will be copied by web generator is a good idea

Also why not having a new small generator called static-asset so user can control the directory

[ovflowd]

IMO have a static dir that will be copied by web generator is a good idea

This should be enough.

But I feel we should automatically detect references to assets, make a Map() and copy them and replace their references.

ie:

<image src="./img.png" />

generator detects that, copies to same relatively output path but then updates the link to <image src="/output/path/from/config/relative-path-to/img.png" />

[moshams272]

But I feel we should automatically detect references to assets, make a Map() and copy them and replace their references.

As a user, I love this solution.

As a developer, I imagine the solution, we have the AST, just traversing on images and then copy and change path with map.

If it's ok and that's the final decision, give me a sign to start implementing it.