summaryrefslogtreecommitdiff
path: root/src/content/blog/using-mdx.mdx
diff options
context:
space:
mode:
authorhouston[bot] <astrobot-houston@users.noreply.github.com>2025-10-19 18:30:51 +0200
committerMatthieu Pignolet <matthieu@puffer.fish>2025-10-19 18:30:51 +0200
commite435718c4dd6e956dc1748689a6156129650c250 (patch)
tree575ab9929930553253b9cf0a8b8843d48d7e6867 /src/content/blog/using-mdx.mdx
Initial commit from Astro
Diffstat (limited to 'src/content/blog/using-mdx.mdx')
-rw-r--r--src/content/blog/using-mdx.mdx31
1 files changed, 31 insertions, 0 deletions
diff --git a/src/content/blog/using-mdx.mdx b/src/content/blog/using-mdx.mdx
new file mode 100644
index 0000000..bd8856e
--- /dev/null
+++ b/src/content/blog/using-mdx.mdx
@@ -0,0 +1,31 @@
+---
+title: 'Using MDX'
+description: 'Lorem ipsum dolor sit amet'
+pubDate: 'Jun 01 2024'
+heroImage: '../../assets/blog-placeholder-5.jpg'
+---
+
+This theme comes with the [@astrojs/mdx](https://docs.astro.build/en/guides/integrations-guide/mdx/) integration installed and configured in your `astro.config.mjs` config file. If you prefer not to use MDX, you can disable support by removing the integration from your config file.
+
+## Why MDX?
+
+MDX is a special flavor of Markdown that supports embedded JavaScript & JSX syntax. This unlocks the ability to [mix JavaScript and UI Components into your Markdown content](https://docs.astro.build/en/guides/markdown-content/#mdx-features) for things like interactive charts or alerts.
+
+If you have existing content authored in MDX, this integration will hopefully make migrating to Astro a breeze.
+
+## Example
+
+Here is how you import and use a UI component inside of MDX.
+When you open this page in the browser, you should see the clickable button below.
+
+import HeaderLink from '../../components/HeaderLink.astro';
+
+<HeaderLink href="#" onclick="alert('clicked!')">
+ Embedded component in MDX
+</HeaderLink>
+
+## More Links
+
+- [MDX Syntax Documentation](https://mdxjs.com/docs/what-is-mdx)
+- [Astro Usage Documentation](https://docs.astro.build/en/guides/markdown-content/#markdown-and-mdx-pages)
+- **Note:** [Client Directives](https://docs.astro.build/en/reference/directives-reference/#client-directives) are still required to create interactive components. Otherwise, all components in your MDX will render as static HTML (no JavaScript) by default.