Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Astro to site generator docs #2118

Merged
merged 18 commits into from Sep 6, 2022
Merged
Changes from 9 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
35 changes: 35 additions & 0 deletions docs/docs/getting-started.server.mdx
Expand Up @@ -636,6 +636,41 @@ well.

See [Using MDX with Next.js][next-mdx] for more details.

#### Astro

[Astro](https://astro.build/) has an [official MDX integration](https://docs.astro.build/guides/integrations-guide/mdx/).
Astro recommends using [the `astro add` CLI](https://docs.astro.build/en/guides/integrations-guide/#automatic-integration-setup)
to install dependencies and update your config automatically:

```sh
# Using npm
npx astro add mdx
bholmesdev marked this conversation as resolved.
Show resolved Hide resolved
# Using yarn
yarn astro add mdx
# Using pnpm
pnpx astro add mdx
```

This base setup allows you to import Markdown,
[Astro components](https://docs.astro.build/en/core-concepts/astro-components/),
and other MDX files as components.

**To add support for [Preact](https://docs.astro.build/en/guides/integrations-guide/preact/), [Vue](https://docs.astro.build/en/guides/integrations-guide/vue/), [Svelte](https://docs.astro.build/en/guides/integrations-guide/svelte/) and more in your MDX,**
bholmesdev marked this conversation as resolved.
Show resolved Hide resolved
you can install each as a separate integration:

```sh
# Using npm
npx astro add preact
bholmesdev marked this conversation as resolved.
Show resolved Hide resolved
# Using yarn
yarn astro add preact
# Using pnpm
pnpx astro add preact
```

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/).

#### Parcel

[Parcel 2](https://v2.parceljs.org) has their own plugin to support MDX.
Expand Down