Skip to content

docs(mdx): note that getHeadings() excludes headings from imported files#14060

Open
SRKrukowski wants to merge 1 commit into
withastro:mainfrom
SRKrukowski:mdx-getheadings-imported-note
Open

docs(mdx): note that getHeadings() excludes headings from imported files#14060
SRKrukowski wants to merge 1 commit into
withastro:mainfrom
SRKrukowski:mdx-getheadings-imported-note

Conversation

@SRKrukowski

Copy link
Copy Markdown

Closes #14042.

On the @astrojs/mdx page, the getHeadings() 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:

...can be used for anchor links. Headings from imported files are not included.

Docs-only, one line.

@netlify

netlify Bot commented Jun 15, 2026

Copy link
Copy Markdown

Deploy Preview for astro-docs-2 failed. Why did it fail? →

Built without sensitive environment variables

Name Link
🔨 Latest commit d389fa1
🔍 Latest deploy log https://app.netlify.com/projects/astro-docs-2/deploys/6a2f6e91500c4800087e464b

@astrobot-houston

Copy link
Copy Markdown
Contributor

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
en/guides/integrations-guide/mdx.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

@astrobot-houston

Copy link
Copy Markdown
Contributor

Hello! Thank you for opening your first PR to Astro’s Docs! 🎉

Here’s what will happen next:

  1. Our GitHub bots will run to check your changes.
    If they spot any broken links you will see some error messages on this PR.
    Don’t hesitate to ask any questions if you’re not sure what these mean!

  2. In a few minutes, you’ll be able to see a preview of your changes on Netlify 🥳.

  3. One or more of our maintainers will take a look and may ask you to make changes.
    We try to be responsive, but don’t worry if this takes a few days.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

MDX docs no longer mention that getHeadings() doesn't support nested MDX files

2 participants