Retain most HTML elements in heading label in Table of Contents #164
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.
Context
Fixes #160.
Here's how we generated heading labels in the Table of Contents before this PR: If a heading contained multiple HTML elements (for instance, formatting), we ignored most of those elements and only used text nodes and codeblocks. However, this was a mistake — @marcus-darden pointed out that headings can have italics and other formatting.
This PR updates the heading-label generation logic to preserve almost all formatting within headings (except for the AnchorJS link).
Validation
I updated the "Install the dependencies" heading in the Project 0 demo spec (
index.md
). Visit the preview URL and observe the label in the sidebar.Preview URL: https://preview.sesh.rs/previews/eecs485staff/primer-spec/164/
Thanks for reporting @marcus-darden!