docs(mdx): note that getHeadings() excludes headings from imported files#14060
docs(mdx): note that getHeadings() excludes headings from imported files#14060SRKrukowski wants to merge 1 commit into
Conversation
❌ Deploy Preview for astro-docs-2 failed. Why did it fail? →Built without sensitive environment variables
|
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
|
Hello! Thank you for opening your first PR to Astro’s Docs! 🎉 Here’s what will happen next:
|
Closes #14042.
On the
@astrojs/mdxpage, thegetHeadings()exported property doesn't mention that headings from imported MDX sub-files are not included in its output. This surprised the issue reporter.Per @ArmandPhilippot's suggestion in the issue (and confirmed to be MDX-specific), this appends a single sentence to the existing description rather than adding an aside:
Docs-only, one line.