bug: <img> & <video> doesn't work with assets in relative paths

[ABausG]

See title.

I was using <img src="/assets/image.png"/> which didn't work.

Upon reading the documentation really carefully I noticed that it only mentioned the <Image> tag and changing it to that worked.

Is there a particular reason why the Mapping of <img> is not working?

Going forward I think there could be two ways:

1. is supported with relative paths
2. A callout is added to the docs hinting that it has to be <Image> and not <img>. Happy to add that respective callout to the docs if desired :)

[Ehesp]

Hey, they should be using the same underlying component, see: https://github.com/invertase/docs.page/blob/main/website/src/components/Markdown.tsx#L43

There's a big update landing tomorrow so I'll double check whether this is still relevant when that lands 👍

[ABausG]

Let's say I am planning on doing an initial release of my docs in let's say the next 30 minutes :D Is there something I had to change right away? :D

[Salakar]

Seems like this is still an issue at least for video components, a reproduction visible on this page: https://docs.page/donnc/jawce/demo

[Ehesp]

Hey @ABausG

My understanding of MDX is that this is intended behaviour - MDX is treating video and img as literals which don't get parsed, see the docs: https://mdxjs.com/docs/using-mdx/#components

TLDR:

The <Video /> and <Image /> components should be used here which pass on the component props of the HTML elements. Is this something you're able to do?

[ABausG]

Yes! Was able to use the full tag.

Notbsure if it might be worth to add a small disclaimer to the docs to indicate that. I had to read the page a couple of times until I noticed it was always talking about Image