Relative links #7
Closed
Conversation
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
mkdocs uses relative links to files while Astro by default uses slugs (and does no built-in validation). Instead of requiring slugs everywhere add an override to do a conversion of links based on the or based on the relative path. An alternative solution would be to do this when converting the docs (e.g. via update-docs.ts) but honestly the devx for linking using slugs everywhere was uglier whereas this is more natural IMHO. Long-term we can probably normalize a bit more, but in the short term this is a good solution. We also started excluding index.md files from the examples directory as they aren't intended to be pages on the docs - they are only present for readability when on GitHub.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
Test PR
Related Issues
Type of Change
Checklist
mkdocs serveBy submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.