From 3f3d5c8a8d4010c8831e79f7baa3e08bf2462881 Mon Sep 17 00:00:00 2001
From: Justin Yao Du <justinyaodu@gmail.com>
Date: Mon, 28 Jun 2021 00:25:45 -0700
Subject: [PATCH] chore(gatsby-plugin-mdx): Add comment why rehype-slug is
 required (#32128)

---
 packages/gatsby-plugin-mdx/README.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/packages/gatsby-plugin-mdx/README.md b/packages/gatsby-plugin-mdx/README.md
index 7b2f7173609fb..fd889fe17ca38 100644
--- 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