fix(v2): static phrasing content should be rendered correctly in TOC #1992
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
|
Deploy preview for docusaurus-2 ready! Built with commit 9ae161f |
|
Deploy preview for docusaurus-preview ready! Built with commit 9ae161f |
yangshun
approved these changes
Nov 14, 2019
yangshun
reviewed
Nov 14, 2019
| @@ -37,7 +37,7 @@ function Headings({headings, isChild}) { | |||
| {headings.map(heading => ( | |||
| <li key={heading.id}> | |||
| <a href={`#${heading.id}`} className={LINK_CLASS_NAME}> | |||
| {heading.value} | |||
| <div dangerouslySetInnerHTML={{__html: heading.value}} /> | |||
There was a problem hiding this comment.
This adds an extra <div> element. Why don't do dangerouslySetInnerHTML on the <a>?
There was a problem hiding this comment.
You are right. I am currently away so will update after that then
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.
Motivation
TOC always render as string. Never putting the html markup.
Previously, only the textual content of headings was used to generate the entries in the Table of Contents. This lead to a bug (or feature?) where HTML in headings made entries in the TOC appear with literal HTML.
Example:
## <i>hello</i>Will be rendered as literal
Other example is below. See that the right toc does not render the emphasis, etc
mdast has a concept of static phrasing content, which includes all the things that can appear in links. Instead of using just the textual content of a heading, this commit introduces a new behaviour where any static phrasing content, such as HTML, inline code, and emphasis, are copied over into the Table of Contents.
See test plan
Have you read the Contributing Guidelines on pull requests?
yes
Test Plan
After. See that its rendered correctly now
