astro/examples/README.md

23 lines
599 B
Markdown
Raw Normal View History

2021-07-16 11:57:09 +00:00
# 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]
2021-07-16 11:57:09 +00:00
```
## 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]
2021-07-16 11:57:09 +00:00
```
Paths to examples nested inside of a repo are also supported:
```
npm init astro -- --template [GITHUB_USER]/[REPO_NAME]/path/to/example
2021-07-16 11:57:09 +00:00
```