diff options
| author |  Ben Holmes <hey@bholmes.dev>
| 2023-01-18 08:43:58 -0500 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2023-01-18 08:43:58 -0500 |
| commit | 7d72aeeae8c867af2ae6c018611e39c184f50619 (patch) | |
| tree | 93015c571dc820db3e37e8eba93455014a048d7e /examples/with-content/src/content/blog/using-mdx.mdx | |
| parent | 006405d33c2b8eb1307cb84161659428e43efa51 (diff) | |
| download | astro-7d72aeeae8c867af2ae6c018611e39c184f50619.tar.gz astro-7d72aeeae8c867af2ae6c018611e39c184f50619.tar.zst astro-7d72aeeae8c867af2ae6c018611e39c184f50619.zip | |
Migrate blog and docs starters to content collections (#5858)
* docs: update README for `content/`
* chore: update env
* feat: update blog to use content collections
* chore: remove with-content starter
* fix: single quotes -> double
* feat: update docs starter to content collections
* refactor: config -> consts
* chore: import type
* edit: Astro will -> Use
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
* chore: remove unused null check
* nit: spacing
* nit: `as Props` 1
Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>
* nit: `as Props` 2
Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>
* chore: consistent CONSTS usage
* chore: `type` imports at top
* chore: consistent quote usage on YAML
* chore: remove `as Props` from docs
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>
Diffstat (limited to 'examples/with-content/src/content/blog/using-mdx.mdx')
| -rw-r--r-- | examples/with-content/src/content/blog/using-mdx.mdx | 31 |
1 files changed, 0 insertions, 31 deletions
diff --git a/examples/with-content/src/content/blog/using-mdx.mdx b/examples/with-content/src/content/blog/using-mdx.mdx deleted file mode 100644 index 036209d3b..000000000 --- a/examples/with-content/src/content/blog/using-mdx.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: 'Using MDX' -description: 'Lorem ipsum dolor sit amet' -pubDate: 'Jul 02 2022' -heroImage: '/placeholder-hero.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. |