astro/examples/README.md
Erika f591150512
Audit examples templates (#3940)
* basics, framework-alpine, framework-solid, delete unused examples

* framework-multiple

* Remove non-standard file extensions, add missing .vscode folders

* Remove robots.txt

* Remove blog-multiple-authors

* Rewrite components comments to be consistent

* Update lockfile

* Remove unnecessary usage of SCSS in subpath example

* Fix props weirdness in portfolio example

* Remove Lit from `framework-multiple` for now

* Misc fixes

* Update lockfile

* I'm in lockfile hell, send help
2022-08-04 14:16:51 -04:00

21 lines
598 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 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
```