feat: mdx TOC #883
Merged
feat: mdx TOC #883
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
|
The failing snapshot is the flaky embed one |
|
@Rafe this is really ready for review |
rafegoldberg
reviewed
Jun 2, 2024
rafegoldberg
approved these changes
Jun 2, 2024
Comment on lines
+25
to
+29
| ``` | ||
| ###A Valid Heading | ||
|
|
||
| Lorem ipsum dolor etc. | ||
| ``` |
There was a problem hiding this comment.
(Not to be picky since I know this isn't technically within the scope of this PR, but I did notice that this compact header notation isn't working with the new MDX processor!)
There was a problem hiding this comment.
components/Heading/index.tsx
Outdated
| </div> | ||
| <a | ||
| key={`heading-anchor-icon-${id}`} | ||
| aria-label={`Skip link to ${children[1]}`} |
There was a problem hiding this comment.
Not sure this children[1] logic still makes sense now that we're getting rid of the showAnchorIcons option?1
Maybe it should just be:
aria-label={`Skip link to ${children}`}Footnotes
-
side note: why are we getting rid of this? is it just not used anywhere? ↩
There was a problem hiding this comment.
I didn't see it used anywhere, so I didn't bother porting it?
Co-authored-by: Rafe Goldberg <rafegoldberg@gmail.com>
|
This PR was released!🚀 Changes included in v6.75.0-beta.48 |
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.
🧰 Changes
TOC!!1!1
The old TOC worked by parsing the
mdastforheadingviamdast-util-toc. This produces anmdastsuitable for rendering via theTableOfContentscomponent. The packageremark-slugappears to be abandoned, and the mdx maintainers recommend usingrehype-slugandrehype-extract-oc.rehype-extract-tocgenerates a POJO that represent the TOC, and it doesn't appear to have any functions for parsing component imports. So, I've implemented a plugin that parses the main doc and it's componentshast's during thecompilestep. Then it can be rendered in theTableOfContentsduring therunstep. This changes the return signatures to be an object instead of a single component, to prevent requiring 2 separate compile and run steps when rendering.Other notable changes:
run,compile,mdx,astProcessorinto their own files under./libStylecomponent.executetest helper.🧬 QA & Testing