typedoc
typedoc copied to clipboard
Cannot link local files/images via markdown image links
Search terms
Markdown, Local files, Relative path
Expected Behavior
When encountering markdown such as

Typedoc should link the referenced file relative to the source of the markdown being parsed
Actual Behavior
TypeDoc will insert the expected <img>
tag, but does not adjust the href and does not include the linked file in the assets folder. This results in broken images.
Steps to reproduce the bug
- Create a typedoc project
- Add an image to the project
- Add a markdown image tag

- Compile with typedoc
- Note that the image is broken
Having traced through the code, it would also be helpful if the MarkdownEvent
was given context information such that extensions could understand what the given markdown relates to and what file it was sourced from.
Ran into this today as well except I'm trying to link to other markdown files by their relative path.
Is there some workaround available? Only think I think of is to manually copy images to assets folder, don't know though if that's best way.