astro/.changeset/fast-baboons-prove.md
2022-12-20 23:08:15 +01:00

659 B

@astrojs/mdx
minor

Run heading ID injection after user plugins

⚠️ BREAKING CHANGE ⚠️

If you are using a rehype plugin that depends on heading IDs injected by Astro, the IDs will no longer be available when your plugin runs by default.

To inject IDs before your plugins run, import and add the rehypeHeadingIds plugin to your rehypePlugins config:

// astro.config.mjs
+ import { rehypeHeadingIds } from '@astrojs/markdown-remark';
import mdx from '@astrojs/mdx';

export default {
  integrations: [mdx()],
  markdown: {
    rehypePlugins: [
+     rehypeHeadingIds,
      otherPluginThatReliesOnHeadingIDs,
    ],
  },
}