Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow relative links to images, or links related to the same branch #702

Open
Zack-83 opened this issue May 7, 2024 · 1 comment
Open

Comments

@Zack-83
Copy link
Contributor

Zack-83 commented May 7, 2024

Is your feature request related to a problem? Please describe.
GitHub-Markdown (or GitLab-Markdown) supports relative links. Therefore it is possible to include, within a document with path //documentation/1.Introduction.md, an image belonging to a "sister" folder, e.g. //visualizations/BuildingBlocks.png.

Widoco does not support that, which forces us to use the full (absolute) path https://git.rwth-aachen.de/nfdi4ing/metadata4ing/metadata4ing/-/blob/develop/visualizations/BuildingBlocks.svg to include an image fom a different folder.

The disadvantage is that the full path contains also the branch. Therefore, if we have more branches at different maturity stages, the documentation for all branches will include always images from one branch, may it be the latest or the earliest, which often creates anachronysms.

Is there a solution for that?

@dgarijo
Copy link
Owner

dgarijo commented May 7, 2024

One option is to create multiple releases, using the direct links to the corresponding file.
The HTML just renders markdown, so if something is supported in markdown it should work too. That said, the sections are loaded dynamically, so I'd use the uniteSections flag

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants