Skip to content

Commit 56d7066

Browse files
bholmesdevwooormsarah11918
authoredSep 6, 2022
Add Astro to site generator docs
Closes GH-2118. Reviewed-by: Titus Wormer <tituswormer@gmail.com> Reviewed-by: Sarah Rainsberger <sarah@rainsberger.ca> Co-authored-by: Titus Wormer <tituswormer@gmail.com> Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
1 parent 996771a commit 56d7066

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed
 

‎docs/docs/getting-started.server.mdx

+19
Original file line numberDiff line numberDiff line change
@@ -481,6 +481,25 @@ Which in turn lets us choose whether to use the `@mdx-js/mdx` or
481481

482482
### Site generators
483483

484+
#### Astro
485+
486+
[Astro](https://astro.build/) has an [official MDX integration](https://docs.astro.build/guides/integrations-guide/mdx/).
487+
You can add the integration with the Astro CLI (recommended):
488+
489+
```sh
490+
npx astro add mdx
491+
```
492+
493+
This base setup allows you to import markdown, Astro components,
494+
and other MDX files as components. To use
495+
other UI framework components in your MDX files
496+
(e.g. Preact, Vue, Svelte and more),
497+
see Astro’s [Framework components](https://docs.astro.build/en/core-concepts/framework-components/) guide.
498+
499+
To learn how to configure layouts, YAML frontmatter, and set up Astro’s
500+
syntax highlighting, [see their MDX
501+
integration docs](https://docs.astro.build/guides/integrations-guide/mdx/).
502+
484503
#### Create React App (CRA)
485504

486505
<Note type="info">

1 commit comments

Comments
 (1)

vercel[bot] commented on Sep 6, 2022

@vercel[bot]

Successfully deployed to the following URLs:

mdx – ./

mdx-mdx.vercel.app
mdxjs.com
mdx-git-main-mdx.vercel.app
v2.mdxjs.com

Please sign in to comment.