table of content slugification differs from anchors slugification

[chenglou]

🐛 Bug Report

If a header is called, for example, Tips & Tricks, the table of content section would slugify that as Tips-amp-tricks whereas the actual hash from the header is tips-tricks

This is more problematic than a mismatching anchor. Docusaurus uses scrollSpy, which fails to find the anchor like so:

This exception then blocks lots of other functionalities on the page (e.g. code tab switching)

Have you read the [Contributing Guidelines on issues]

Yeah

To Reproduce

(Write your steps here:)

1. Write any markdown doc, add a header # Tips & Tricks
2. Check console

The problem comes from these lines:

docusaurus/packages/docusaurus-1.x/lib/core/toc.js

Line 40 in 6670c53

const rendered = md.renderInline(rawContent);

docusaurus/packages/docusaurus-1.x/lib/core/anchors.js

Line 25 in 6670c53

const anchor = toSlug(textToken.content, slugger);

If you console.log(rendered) in the first snippet, the sanitization turns Tips & Tricks into Tips & Tricks. Whereas if you console.log(textToken.content) in the latter snippet, it's still Tips & Tricks.

cc @JoelMarcey

[JoelMarcey]

@chenglou Your website is still on v1 of Docusaurus, right?

cc @yangshun

[yangshun]

Yes this is v1.

[theosherry]

@chenglou @yangshun This issue was fixed with #2019

[yangshun]

Hmm @chenglou are you using the latest Docusaurus v1?

[slorber]

The Docusaurus team is actively working on Docusaurus v2.

After a very long alpha, Docusaurus v2 is now in beta.
We believe that the v2 beta is already better than v1, and v2 is ready for maintstream adoption.

Apart from critical issues and security fixes, we don't plan to invest much time on Docusaurus v1 anymore.

We are all closing v1 issues.
Maybe the current issue is already fixed in Docusaurus v2.
Please try to upgrade, and if the issue is still there on Docusaurus v2, open a new issue.