refactor: make MDX export a flat TOC list instead of tree #6729
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
Josh-Cena
added
the
pr: breaking change
|
✔️ [V2] 🔨 Explore the source changes: c8f0faa 🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/62131f209850e9000797a761 😎 Browse the preview: https://deploy-preview-6729--docusaurus-2.netlify.app |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-6729--docusaurus-2.netlify.app/ |
|
Size Change: +478 B (0%) Total Size: 782 kB
ℹ️ View Unchanged
|
Josh-Cena
force-pushed
the
jc/refactor-toc
branch
from
6561c96 to
c8c287a
Compare
Josh-Cena
added
the
status: awaiting review
|
Thanks, LGTM 👍 Couldn't see any issue even on weird page like this one: https://deploy-preview-6729--docusaurus-2.netlify.app/tests/docs/toc/toc-test-bad/ Let's wait for users to complain before implementing anything extra that maybe nobody needs |
Josh-Cena
removed
the
status: awaiting review
3 tasks
2 tasks
ISSOtm
added a commit
to gbdev/rgbds-www
that referenced
this pull request
Apr 19, 2024
Until Docusaurus 2.0.0-beta16, the ToC was a tree structure; since facebook/docusaurus#6729, it is flat instead. The mismatch caused level 3 headings not to appear in the ToC.
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.
Breaking change
TOCItemshave changed. You may need to re-swizzleTOCItems. Good news is,TOC,TOCCollapsible, etc. don't need to be changed.toc={[toc[2], toc[4]]}has been removed. If you previously usedTOCInlinebut treatedtocas an opaque data structure (only passing it astoc={toc}, you are safe; but if you relied on its tree structure properties, you may need to implement your own helper function to select all the wanted headings.@slorber Do you think we should provide this helper function ourselves? Something like
useTOCNodes([2, 4]). We may even allow a prop callback:filterTOC={(tocTree) => [toc[2], toc[4]]}which gets called after the TOC has been treeified. It would not be hard to build, just unsure of the value.Motivation
This is a necessary step to work on #3915. See also #6201.
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
Made more tests