chore(gatsby-plugin-mdx): Add comment why rehype-slug is required (#3…

…2128)
gatsbyjs · Jun 28, 2021 · 3f3d5c8 · 3f3d5c8
1 parent 31828e4
commit 3f3d5c8
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/packages/gatsby-plugin-mdx/README.md b/packages/gatsby-plugin-mdx/README.md
@@ -405,6 +405,7 @@ module.exports = {
       resolve: `gatsby-plugin-mdx`,
       options: {
         rehypePlugins: [
+          // Generate heading ids for rehype-autolink-headings
           require("rehype-slug"),
           // To pass options, use a 2-element array with the
           // configuration in an object in the second element