Detailed use of custom component with imported MDX

christian-hackyourshack · christian-hackyourshack · commit 5bf5d8bd0be8 · 2022-10-25T19:40:45.000+02:00
Incorporated all review comments from Sarah and Ben manually,
because the old branch would not pass the mergeability check.
diff --git a/packages/integrations/mdx/README.md b/packages/integrations/mdx/README.md
@@ -343,15 +343,17 @@ Now, writing the standard Markdown blockquote syntax (`>`) will use your custom
 
 #### Custom components with imported `mdx`
 
-When rendering imported MDX content, custom components can also be passed via the `components` prop:
+When rendering imported MDX content, custom components can be passed via the `components` prop.
 
-```astro title="src/pages/page.astro" "components={{ h1: Heading }}"
+Note: An MDX file's exported components will _not_ be used unless you manually import and pass them via the `components` property. See the example below:
+
+```astro title="src/pages/page.astro" "components={{...components, h1: Heading }}"
 ---
-import Content from '../content.mdx';
+import { Content, components } from '../content.mdx';
 import Heading from '../Heading.astro';
 ---
 
-<Content components={{ h1: Heading }} />
+<Content components={{...components, h1: Heading }} />
 ```
 
 ### Syntax highlighting
