Generators/HTML: improve anchor links #859
Merged
+667
−79
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
|
Rebased without changes - branch protection requirement have changed. |
jrfnl
force-pushed
the
feature/generators-improve-anchor-links
branch
from
226875a to
c7bb306
Compare
fredden
reviewed
Mar 7, 2025
jrfnl
force-pushed
the
feature/generators-improve-anchor-links
branch
2 times, most recently
from
10b2d4e to
b2fba89
Compare
fredden
approved these changes
Mar 10, 2025
|
Thanks @fredden for reviewing this one again. I've fixed up both your remarks (locally) and will put them in the correct "originating" commit and rebase the PR (without any other changes but those mentioned above) before merging. |
Move the creation of in-page anchor link text to a separate function as this was done in two separate places. The separate function will make it more straight-forward to safeguard that the anchors and the links to these anchors stay in sync.
As things were, the TOC would link to the section headers, but there was no straight-forward way to copy the link to a particular section once a user was viewing the section. This small change adds an invisible `§` character after each section title, which becomes visible when the user hovers over the title and allows for copying the permalink to that section. Includes updated test expectations.
... to prevent issues with URL encoding. Note: as this _may_ result in duplicate anchor links, this commit includes a protection against this by adding a numeric suffix to the anchor if a duplicate is detected. Includes a test with a variety of non-ascii chars and duplicate titles. Includes updated test expectations for various other tests.
jrfnl
force-pushed
the
feature/generators-improve-anchor-links
branch
from
b2fba89 to
462ff5f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Generators/HTML: move section link creation to own function
Move the creation of in-page anchor link text to a separate function as this was done in two separate places.
The separate function will make it more straight-forward to safeguard that the anchors and the links to these anchors stay in sync.
Generators/HTML: improve anchor links
As things were, the TOC would link to the section headers, but there was no straight-forward way to copy the link to a particular section once a user was viewing the section.
This small change adds an invisible
§character after each section title, which becomes visible when the user hovers over the title and allows for copying the permalink to that section.Includes updated test expectations.
🆕 Generators/HTML: slugify anchor links
... to prevent issues with URL encoding.
Note: as this may result in duplicate anchor links, this commit includes a protection against this by adding a numeric suffix to the anchor if a duplicate is detected.
Includes a test with a variety of non-ascii chars and duplicate titles.
Includes updated test expectations for various other tests.
Screenshot
Suggested changelog entry
Generators/HTML: each section title now has a proper and unique anchor link, allowing for copying the link to a specific section of the documentation.
Related issues/external references
This PR is part of a series of PRs which will add a complete set of tests (and improvements) for the Generator feature.
Also see: #671 and other PRs with the Core Component: Generators label.