diff options
author | 2025-06-05 14:25:23 +0000 | |
---|---|---|
committer | 2025-06-05 14:25:23 +0000 | |
commit | e586d7d704d475afe3373a1de6ae20d504f79d6d (patch) | |
tree | 7e3fa24807cebd48a86bd40f866d792181191ee9 /examples/README.md | |
download | astro-latest.tar.gz astro-latest.tar.zst astro-latest.zip |
Sync from a8e1c0a7402940e0fc5beef669522b315052df1blatest
Diffstat (limited to 'examples/README.md')
-rw-r--r-- | examples/README.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 000000000..1482084d4 --- /dev/null +++ b/examples/README.md @@ -0,0 +1,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 +``` |