summaryrefslogtreecommitdiff
path: root/docs/src/pages/getting-started.md
diff options
context:
space:
mode:
authorGravatar Fred K. Schott <fkschott@gmail.com> 2021-09-06 01:23:19 -0700
committerGravatar Fred K. Schott <fkschott@gmail.com> 2021-09-06 01:23:19 -0700
commit6185f9f7b15908b48f9ae2e1d532634f5b59c9f9 (patch)
tree12ec4f4a8a469a7d92f2a127ed2e4d34013f6e7c /docs/src/pages/getting-started.md
parente686c3c50469d18db93da7ce79ddcac8659c3166 (diff)
parent6dc05575a65bf6bdc6f52848d274b1f333a36076 (diff)
downloadastro-6185f9f7b15908b48f9ae2e1d532634f5b59c9f9.tar.gz
astro-6185f9f7b15908b48f9ae2e1d532634f5b59c9f9.tar.zst
astro-6185f9f7b15908b48f9ae2e1d532634f5b59c9f9.zip
Docs/example and templates v2 (#1100)
Diffstat (limited to 'docs/src/pages/getting-started.md')
-rw-r--r--docs/src/pages/getting-started.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/src/pages/getting-started.md b/docs/src/pages/getting-started.md
index 73ac8e0d7..df8d43eef 100644
--- a/docs/src/pages/getting-started.md
+++ b/docs/src/pages/getting-started.md
@@ -15,6 +15,20 @@ To get started with Astro in 5 quick and easy steps, visit our [Quick-Start guid
Alternatively, read our [Installation Guide](/installation) for a full walk-through on getting set up with Astro.
+### Example Projects
+
+If you prefer to learn Astro by example, check out our [complete library of examples](https://github.com/snowpackjs/astro/tree/main/examples) on GitHub.
+
+You can check out any of these examples on your local machine by running `npm init astro` with the `--template` CLI flag. The `--template` flag also supports third-party, community templates.
+
+```bash
+# Run the init wizard and use this official template
+npm init astro -- --template [OFFICIAL_EXAMPLE_NAME]
+# Run the init wizard and use this community template
+npm init astro -- --template [GITHUB_USER]/[REPO_NAME]
+npm init astro -- --template [GITHUB_USER]/[REPO_NAME]/path/to/example
+```
+
### Online Playgrounds
If you're interested in playing around with Astro in the browser, you can use an online code playground. Try our "Hello World!" template on [CodeSandbox](https://codesandbox.io/s/astro-template-hugb3).