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

Fix markdown links #128

Merged
merged 2 commits into from
Jan 20, 2025
Merged

Fix markdown links #128

merged 2 commits into from
Jan 20, 2025

Conversation

erickguan
Copy link
Contributor

I found links broken in #125. I tried this part of text with a GitHub-flavored markdown editor. The auto-link probably doesn't work with the nested []. The other standard, commonmark doesn't accept either link. Anyway, here is the fix to render links properly.

Also, I link the LICENSE document.

erickguan and others added 2 commits December 26, 2024 22:14
the readme is also rendered on crates.io and docs.rs and I'm not
sure how they handle relative links in the readme, so just use the
full URL to be safe
@matsadler
Copy link
Owner

Thanks for catching this. I thought I'd checked those links would render ok, but I think I must have checked them with the inline syntax and then later changed my mind and switched to the footnote syntax.

@matsadler matsadler merged commit 6a0b737 into matsadler:main Jan 20, 2025
43 checks passed
@erickguan erickguan deleted the fix-md-125 branch January 21, 2025 12:31
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

Successfully merging this pull request may close these issues.

2 participants