Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: remove problematic mdx2 anchor id docs for MDX 2 migration #8788

Merged
merged 1 commit into from Mar 17, 2023

Conversation

slorber
Copy link
Collaborator

@slorber slorber commented Mar 17, 2023

For MDX 2 (#8288) we have to apply a pre-processing step to escape heading ids so that it is valid MDX 2:

-## Custom ID headers {#custom-id}
+## Custom ID headers \{#custom-id}

This usually works fine but when this is found inside a Markdown code block then it should probably be escaped.

It's possible to hack around this pre-processing by using JSX (or to fix the pre-processing but it would become less efficient).

Instead I choose to simply remove this special anchor id doc from the example here, considering it's already documented here: https://docusaurus.io/docs/markdown-features/toc#heading-ids

We can reintroduce this later if needed but for now it's simpler to remove it.

Removed in main so that my visual diff tool does not report a false positive.
CF https://app.argos-ci.com/slorber/docusaurus-visual-tests/builds/21/41550827

@slorber slorber added the pr: documentation This PR works on the website or other text documents in the repo. label Mar 17, 2023
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Mar 17, 2023
@netlify
Copy link

netlify bot commented Mar 17, 2023

[V2]

Name Link
🔨 Latest commit 4bd1ec8
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/64149d6e3c182400080e3259
😎 Deploy Preview https://deploy-preview-8788--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions
Copy link

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🔴 43 🟢 97 🟢 100 🟢 100 🟢 90 Report
/docs/installation 🟠 71 🟢 100 🟢 100 🟢 100 🟢 90 Report

@slorber slorber merged commit 361dfda into main Mar 17, 2023
9 checks passed
@slorber slorber deleted the slorber/remove-annoying-custom-heading-id-docs branch March 17, 2023 17:10
@github-actions
Copy link

Size Change: 0 B

Total Size: 952 kB

ℹ️ View Unchanged
Filename Size
website/.docusaurus/globalData.json 86.2 kB
website/build/assets/css/styles.********.css 113 kB
website/build/assets/js/main.********.js 712 kB
website/build/index.html 41.1 kB

compressed-size-action

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: documentation This PR works on the website or other text documents in the repo.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants