mirror of
https://github.com/withastro/astro.git
synced 2024-12-16 21:46:22 -05:00
a800bf7ec1
* .md only: npm init astro --> npm create astro For consistency with https://github.com/withastro/docs/pull/360. Docs always use `npm create astro` (never `npm init astro`), README.md files in this repo should do the same. Search: `\b(npm|yarn|pnpm) init astro\b` Replace: `$1 create astro` Except for two instances: 1. `packages/create-astro/CHANGELOG.md` -- skipped because changelog. 2. `packages/create-astro/test/create-astro.test.js.skipped` -- skipped, old test disabled in https://github.com/withastro/astro/pull/3168. * docs: add `@latest` to `npm create astro` Co-authored-by: Bjorn Lu <bjorn@bjornlu.com> Co-authored-by: Michael Rienstra <michael@goodmoney.com>
21 lines
634 B
Markdown
21 lines
634 B
Markdown
# 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 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:
|
|
|
|
```
|
|
npm create astro@latest -- --template [GITHUB_USER]/[REPO_NAME]
|
|
```
|
|
|
|
Paths to examples nested inside of a repo are also supported:
|
|
|
|
```
|
|
npm create astro@latest -- --template [GITHUB_USER]/[REPO_NAME]/path/to/example
|
|
```
|