Use relative paths for generated docsify links#32
Merged
Conversation
explorigin
approved these changes
May 31, 2023
Contributor
explorigin
left a comment
explorigin
left a comment
There was a problem hiding this comment.
Should not break existing relative links (those without ./ prefix) either so I don't see any harm.
kevin-secrist
approved these changes
May 31, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Relative paths in markdown do not work w/ the default docsify settings.
e.g. currently published docs (via #31) @ https://rss-engineering.github.io/terraform/#/modules/security_hub have a relative link to another doc in the same folder:
When rendered by docsify, it results in a non-existent destination:
Setting
relativePath: truewill correctly render the link and preserve the ability to navigate*.mddocs in the Github UI:See https://docsify.js.org/#/configuration?id=relativepath