From 56d70660dee347b77f87854c7948e914e4b12971 Mon Sep 17 00:00:00 2001 From: Ben Holmes Date: Tue, 6 Sep 2022 12:42:21 -0400 Subject: [PATCH] Add Astro to site generator docs Closes GH-2118. Reviewed-by: Titus Wormer Reviewed-by: Sarah Rainsberger Co-authored-by: Titus Wormer Co-authored-by: Sarah Rainsberger --- docs/docs/getting-started.server.mdx | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/docs/getting-started.server.mdx b/docs/docs/getting-started.server.mdx index 2e0abb5b2..5c1819b74 100644 --- a/docs/docs/getting-started.server.mdx +++ b/docs/docs/getting-started.server.mdx @@ -481,6 +481,25 @@ Which in turn lets us choose whether to use the `@mdx-js/mdx` or ### Site generators +#### Astro + +[Astro](https://astro.build/) has an [official MDX integration](https://docs.astro.build/guides/integrations-guide/mdx/). +You can add the integration with the Astro CLI (recommended): + +```sh +npx astro add mdx +``` + +This base setup allows you to import markdown, Astro components, +and other MDX files as components. To use +other UI framework components in your MDX files +(e.g. Preact, Vue, Svelte and more), +see Astro’s [Framework components](https://docs.astro.build/en/core-concepts/framework-components/) guide. + +To learn how to configure layouts, YAML frontmatter, and set up Astro’s +syntax highlighting, [see their MDX +integration docs](https://docs.astro.build/guides/integrations-guide/mdx/). + #### Create React App (CRA)