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 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/docs/getting-started.server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -636,6 +636,33 @@ well.

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

#### Astro

[Astro](https://astro.build/) is built on [islands architecture](https://docs.astro.build/concepts/islands/),
allowing you to use React, Vue, Svelte, and more within your MDX files.
bholmesdev marked this conversation as resolved.
Show resolved Hide resolved

After [creating your first Astro project](https://astro.new/), you can [add the MDX integration](https://docs.astro.build/guides/integrations-guide/mdx/):
bholmesdev marked this conversation as resolved.
Show resolved Hide resolved

```shell
bholmesdev marked this conversation as resolved.
Show resolved Hide resolved
astro add mdx
bholmesdev marked this conversation as resolved.
Show resolved Hide resolved
# Or use "npx" on Windows
bholmesdev marked this conversation as resolved.
Show resolved Hide resolved
npx astro add mdx
bholmesdev marked this conversation as resolved.
Show resolved Hide resolved
```

And (optionally) add your favorite component framework(s).
You can import Markdown, Astro, and other MDX files as components
out-of-the-box.

```shell
bholmesdev marked this conversation as resolved.
Show resolved Hide resolved
astro add preact
# Or use "npx" on Windows
bholmesdev marked this conversation as resolved.
Show resolved Hide resolved
npx astro add preact
bholmesdev marked this conversation as resolved.
Show resolved Hide resolved
```

[See the Astro documention](https://docs.astro.build/guides/integrations-guide/mdx/)
for configuring layouts,
built-in syntax highlighting with Shiki, adding YAML frontmatter, and more.
bholmesdev marked this conversation as resolved.
Show resolved Hide resolved

#### Parcel

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