fix(v2): remove HTML from heading slug #2426
Merged
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 f0fdcc6 |
lex111
commented
Mar 18, 2020
| @@ -62,7 +62,7 @@ exports[`non text phrasing content 1`] = ` | |||
| }, | |||
| { | |||
| value: '<i>HTML</i>', | |||
| id: 'ihtmli', | |||
| id: 'html', | |||
|
|
||
| const processFixture = async (name, options) => { | ||
| const path = join(__dirname, 'fixtures', `${name}.md`); | ||
| const file = await vfile.read(path); | ||
| const result = await remark() | ||
| .use(slug) |
There was a problem hiding this comment.
Here I use our slugger plugin, because these plugins are interdependent:
Therefore the tests should take this fact into account.
FYI, rightToc also generated slug, which is actually somewhat redundant, because we already did this in the slugger (ex-remark-slug) plugin.
yangshun
reviewed
Mar 21, 2020
yangshun
approved these changes
Mar 21, 2020
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
Resolve #2419
Currently, the use of HTML in headings is reflected in slug, see the example below:
Using this heading:
## <span className="faq-header">General</span>will lead to slug of "span-classname-faq-header-general" instead of "general".
I made a kind of fork remark-slug, because to solve this bug we need to change the way the slug is generated. To ensure that nothing broke, I adopted the tests from the underlying lib (rewritten to Jest) and added a new test that confirms the fix for this bug.
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
Try add heading which contains HTML (see Motivation section for sample).
Related PRs
(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)