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: Remove all punctuation from anchors in policies.md #565

Merged
merged 1 commit into from
Feb 22, 2025

Conversation

zephyrdb
Copy link
Contributor

@zephyrdb zephyrdb commented Dec 17, 2024

Punctuation breaks anchor links in Markdown. This implements the same rule as GitHub.

(While testing, I realized that it's probably also important to escape Markdown characters in other fields. I didn't do that for the description, in case someone actually wants to use Markdown there.)

@zephyrdb zephyrdb changed the title Remove all punctuation from anchors in policies.md fix: Remove all punctuation from anchors in policies.md Dec 17, 2024
@zephyrdb zephyrdb force-pushed the no-punctuation-in-anchors branch from dd99b99 to 566bc25 Compare December 17, 2024 22:12
@zephyrdb zephyrdb mentioned this pull request Jan 26, 2025
Copy link
Collaborator

@jalseth jalseth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR!

@zephyrdb zephyrdb force-pushed the no-punctuation-in-anchors branch 12 times, most recently from 14cdf34 to 1780a51 Compare February 11, 2025 00:41
@zephyrdb
Copy link
Contributor Author

zephyrdb commented Feb 11, 2025

So uh, I added a test in the form of an example. Which isn't ideal, but it's the only way to be sure that not only does the code work, the Markdown does what it says on the tin. I found a number of odd things in the course of that, including the part where cmd-click in VSCode works on the anchor in the editor (once I removed trailing space), but clicking in my Markdown preview plugin doesn't. It seems to be ok on GitHub, though, and it's a pretty contrived example to begin with. I'll do a little more poking around tomorrow just in case.

@zephyrdb zephyrdb force-pushed the no-punctuation-in-anchors branch from 1780a51 to 179cd06 Compare February 12, 2025 00:11
@zephyrdb zephyrdb marked this pull request as draft February 12, 2025 00:11
@zephyrdb zephyrdb force-pushed the no-punctuation-in-anchors branch from 179cd06 to 74a5edb Compare February 12, 2025 20:10
@zephyrdb zephyrdb marked this pull request as ready for review February 12, 2025 20:18
@zephyrdb
Copy link
Contributor Author

zephyrdb commented Feb 12, 2025

Ok a bunch more work later, I think this is as thorough as it can possibly be without being unreasonably complicated and resource-consuming.

@zephyrdb zephyrdb force-pushed the no-punctuation-in-anchors branch from 74a5edb to 32e0fd0 Compare February 12, 2025 20:21
@zephyrdb zephyrdb requested review from jalseth and mrueg February 12, 2025 20:23
@zephyrdb zephyrdb force-pushed the no-punctuation-in-anchors branch 3 times, most recently from 3f12535 to 7fe3a5a Compare February 14, 2025 17:04
@zephyrdb zephyrdb force-pushed the no-punctuation-in-anchors branch from 7fe3a5a to 88544fb Compare February 19, 2025 22:45
Copy link
Collaborator

@jalseth jalseth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@jalseth jalseth merged commit 42179f7 into plexsystems:main Feb 22, 2025
11 checks passed
@zephyrdb zephyrdb deleted the no-punctuation-in-anchors branch February 24, 2025 15:59
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.

3 participants