Add anchors for headings in handbook pages #115
Conversation
This file contains 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
|
@tareiking Does this work for you? |
kadamwhite
reviewed
Dec 22, 2022
| * @return string $content The filtered post content. | ||
| */ | ||
| function anchor_content_headings( $content ) { | ||
| $content = preg_replace_callback( "/\<h([1|2|3|4|5])\>(.*?)\<\/h([1|2|3|4|5])\>/", function ( $matches ) { |
There was a problem hiding this comment.
There is no guard to prevent this matching a heading which already contains linked text, and a link cannot appear inside a link so one of them would break.
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.
When deep-linking handbook content it's not easy to get a URL directly to the relevant heading ie:
HOW AND WHEN SHOULD I UPDATE MY PDP?Why this is useful? When sharing specific handbook information (policies, or specific policies etc) we will share the page link, then tell the person to scroll to x heading. So much mental weight can be lifted by matching the reader experience with current day expectations.
Related: https://github.com/humanmade/H2/issues/418 however - the code there may not be instantly portable.