summaryrefslogtreecommitdiff
path: root/examples/README.md
blob: 50caa7f1801b6c003e0bc9c0c33a4e1cab51dfd0 (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:

```
npm init astro -- --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 init astro` to check out any community examples:

```
npm init astro -- --template [GITHUB_USER]/[REPO_NAME]
```

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

```
npm init astro -- --template [GITHUB_USER]/[REPO_NAME]/path/to/example
```