Extract MDX headings #16
Open
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
kroeder
reviewed
Mar 16, 2024
| @@ -151,6 +153,17 @@ export const extractImports = (root: t.File) => { | |||
| return varToImport; | |||
| }; | |||
|
|
|||
| export const getHeadings = (root: any) => { | |||
| const headings = [] as string[]; | |||
| ['h1', 'h2', 'h3', 'h4'].forEach((tag) => { | |||
There was a problem hiding this comment.
Would it be difficult to have options for that? People probably have different opinions about "what should be searchable" and maybe want something like
docs: {
includeInSearch: 'h1, h2'
}
or something?
There was a problem hiding this comment.
Good idea. I'll implement it all end-to-end using this simple method and then see how disruptive it is to make it configurable
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.
Issue: N/A
What Changed
Extract h1-h4 MDX headings for better search
How to test
See unit tests
Change Type
maintenancedocumentationpatchminormajor📦 Published PR as canary version:
3.0.1--canary.16.72d7283.0✨ Test out this PR locally via:
npm install @storybook/docs-mdx@3.0.1--canary.16.72d7283.0 # or yarn add @storybook/docs-mdx@3.0.1--canary.16.72d7283.0