Skip to content
This repository was archived by the owner on Jun 1, 2023. It is now read-only.

Relative links are broken in markdown #126

Closed
mattpolzin opened this issue May 24, 2020 · 1 comment · Fixed by #127
Closed

Relative links are broken in markdown #126

mattpolzin opened this issue May 24, 2020 · 1 comment · Fixed by #127

Comments

@mattpolzin
Copy link
Contributor

When generating markdown, especially for use in GitHub, I like to rely on relative links as a robust way to link between documentation files living at file paths consistent relative to each other.

When I run the current GitHub Action, the default baseURL is used ("/"). This results in broken links between documentation files within GitHub or the GitHub Wiki.

I think this is partially solved by exposing the --base-url argument via the GitHub action (should this also default to "./" to coincide with the default format of .commonmark?).

That is only half the solution, though, because setting the baseURL to "./" results in Links prefixed with "/./". The solution to the second part of this appears to be straight forward enough, but time, experience, and feedback from maintainers will prove or disprove that!

@mattpolzin
Copy link
Contributor Author

I've got this WIP. Will PR soon.

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

Successfully merging a pull request may close this issue.

1 participant