summaryrefslogtreecommitdiff
path: root/examples/README.md
blob: 1482084d42df319dddc28fff283b6e2fa756f5a6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# Astro Examples Library

The easiest way to check out one of these examples on your machine is by running this command in an empty directory:

```sh
npm create astro@latest -- --template [EXAMPLE_NAME]
```

## Community Examples

Visit [awesome-astro](https://github.com/one-aalam/awesome-astro) for a full list of community examples. You can use `npm create astro@latest` to check out any community examples:

```sh
npm create astro@latest -- --template [GITHUB_USER]/[REPO_NAME]
```

Paths to examples nested inside of a repo are also supported:

```sh
npm create astro@latest -- --template [GITHUB_USER]/[REPO_NAME]/path/to/example
```