Skip to content
New issue

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

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

Already on GitHub? # to your account

Table of contents links won't work if special characters present #3

Open
kieranjol opened this issue Sep 7, 2023 · 1 comment
Open
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@kieranjol
Copy link
Contributor

I've noticed some links in the table of contents contain charaters like commas, slashes, brackets etc.
These result in non-functioning links. Examples include:

https://github.com/digipres/policies#james-hardiman-library,-nui-galway
https://github.com/digipres/policies#national-library-of-new-zealand-/-archives-new-zealand
https://github.com/digipres/policies#royal-pavillion-&-museums-trust--(brighton-and-hove-museums)

I only picked up on this when working on #2 and noticed that the preview had a few dead links.
I'm not sure what the best solution to this is!

@ross-spencer ross-spencer added help wanted Extra attention is needed good first issue Good for newcomers labels Nov 2, 2023
@bitsgalore
Copy link
Contributor

bitsgalore commented Mar 20, 2024

I fixed the 3 broken links in the following commit:

1f44d2d

Oddly this resulted in a complete rewrite of the top 120 lines, not entirely sure why, and this makes my changes quite difficult to spot.

EDIT: deleted commit which was a manual edit of the README; however this should be fixed at the level of the script that generates the Markdown from the CSV.

But there are many more broken links that could be fixed in a similar way. Some useful resources I found along the way:

The key point is being aware how links and anchors are handled in Markdown, which is explained here. But it seems there are quite a few special cases, mostly related to particular characters.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants