summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Caleb Jasik <calebjasik@jasik.xyz> 2021-07-20 20:06:11 -0500
committerGravatar GitHub <noreply@github.com> 2021-07-20 20:06:11 -0500
commit8eeb6b4fe8e116f34a2058891d180dbb6fbcdc29 (patch)
tree4bcaeee237df7831ac26d4bb651f63c50d8f88e5
parentc1e304dfb8ce5a6939010c673db52bd29b33d4d3 (diff)
downloadastro-8eeb6b4fe8e116f34a2058891d180dbb6fbcdc29.tar.gz
astro-8eeb6b4fe8e116f34a2058891d180dbb6fbcdc29.tar.zst
astro-8eeb6b4fe8e116f34a2058891d180dbb6fbcdc29.zip
Docs: npm@7 requires an extra `--` for arguments passed to the command, per @natemoo-re's description. (#786)
-rw-r--r--examples/README.md6
-rw-r--r--examples/blog-multiple-authors/README.md2
-rw-r--r--examples/blog/README.md2
-rw-r--r--examples/docs/README.md2
-rw-r--r--examples/framework-multiple/README.md2
-rw-r--r--examples/framework-preact/README.md2
-rw-r--r--examples/framework-react/README.md2
-rw-r--r--examples/framework-svelte/README.md2
-rw-r--r--examples/framework-vue/README.md2
-rw-r--r--examples/portfolio/README.md2
-rw-r--r--examples/with-markdown/README.md2
-rw-r--r--examples/with-nanostores/README.md2
-rw-r--r--examples/with-tailwindcss/README.md2
13 files changed, 15 insertions, 15 deletions
diff --git a/examples/README.md b/examples/README.md
index 557736ab2..e3e295b6d 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -4,7 +4,7 @@
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]
+npm init astro -- --template [EXAMPLE_NAME]
```
## Community Examples
@@ -12,11 +12,11 @@ npm init astro --template [EXAMPLE_NAME]
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]
+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
+npm init astro -- --template [GITHUB_USER]/[REPO_NAME]/path/to/example
```
diff --git a/examples/blog-multiple-authors/README.md b/examples/blog-multiple-authors/README.md
index 2041dd1a2..d2f1f31fd 100644
--- a/examples/blog-multiple-authors/README.md
+++ b/examples/blog-multiple-authors/README.md
@@ -1,7 +1,7 @@
# Astro Starter Kit: Blog with Multiple Authors
```
-npm init astro --template blog-multiple-authors
+npm init astro -- --template blog-multiple-authors
```
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
diff --git a/examples/blog/README.md b/examples/blog/README.md
index ae86603df..73a4d30ca 100644
--- a/examples/blog/README.md
+++ b/examples/blog/README.md
@@ -1,7 +1,7 @@
# Astro Starter Kit: Blog
```
-npm init astro --template blog
+npm init astro -- --template blog
```
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
diff --git a/examples/docs/README.md b/examples/docs/README.md
index 22f4f40a9..7cfe8981f 100644
--- a/examples/docs/README.md
+++ b/examples/docs/README.md
@@ -1,7 +1,7 @@
# Astro Starter Kit: Docs Site
```
-npm init astro --template docs
+npm init astro -- --template docs
```
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
diff --git a/examples/framework-multiple/README.md b/examples/framework-multiple/README.md
index ee5f77622..0556e54af 100644
--- a/examples/framework-multiple/README.md
+++ b/examples/framework-multiple/README.md
@@ -1,7 +1,7 @@
# Kitchen Sink: Microfrontends with Astro
```
-npm init astro --template framework-multiple
+npm init astro -- --template framework-multiple
```
This example showcases Astro's built-in support for multiple frameworks ([React](https://reactjs.org), [Preact](https://preactjs.com), [Svelte](https://svelte.dev), and [Vue (`v3.x`)](https://v3.vuejs.org/)).
diff --git a/examples/framework-preact/README.md b/examples/framework-preact/README.md
index 419946cb4..c22362325 100644
--- a/examples/framework-preact/README.md
+++ b/examples/framework-preact/README.md
@@ -1,7 +1,7 @@
# Using Preact with Astro
```
-npm init astro --template framework-preact
+npm init astro -- --template framework-preact
```
This example showcases Astro's built-in support for [Preact](https://preactjs.com/).
diff --git a/examples/framework-react/README.md b/examples/framework-react/README.md
index 51eaa7f93..dd82a447f 100644
--- a/examples/framework-react/README.md
+++ b/examples/framework-react/README.md
@@ -1,7 +1,7 @@
# Using React with Astro
```
-npm init astro --template framework-react
+npm init astro -- --template framework-react
```
This example showcases Astro's built-in support for [React](https://reactjs.org/).
diff --git a/examples/framework-svelte/README.md b/examples/framework-svelte/README.md
index 91d19e163..465863f72 100644
--- a/examples/framework-svelte/README.md
+++ b/examples/framework-svelte/README.md
@@ -1,7 +1,7 @@
# Using Svelte with Astro
```
-npm init astro --template framework-svelte
+npm init astro -- --template framework-svelte
```
This example showcases Astro's built-in support for [Svelte](https://svelte.dev/).
diff --git a/examples/framework-vue/README.md b/examples/framework-vue/README.md
index b62554138..c5818e51f 100644
--- a/examples/framework-vue/README.md
+++ b/examples/framework-vue/README.md
@@ -1,7 +1,7 @@
# Using Vue with Astro
```
-npm init astro --template framework-vue
+npm init astro -- --template framework-vue
```
This example showcases Astro's built-in support for [Vue (`v3.x`)](https://v3.vuejs.org/).
diff --git a/examples/portfolio/README.md b/examples/portfolio/README.md
index 083eed318..4b2bb9d74 100644
--- a/examples/portfolio/README.md
+++ b/examples/portfolio/README.md
@@ -1,7 +1,7 @@
# Astro Starter Kit: Portfolio
```
-npm init astro --template portfolio
+npm init astro -- --template portfolio
```
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
diff --git a/examples/with-markdown/README.md b/examples/with-markdown/README.md
index d317547cb..8f72ad497 100644
--- a/examples/with-markdown/README.md
+++ b/examples/with-markdown/README.md
@@ -1,7 +1,7 @@
# Astro Example: Markdown
```
-npm init astro --template with-markdown
+npm init astro -- --template with-markdown
```
This example showcases Astro's [built-in Markdown support](../../docs/markdown.md).
diff --git a/examples/with-nanostores/README.md b/examples/with-nanostores/README.md
index 87025cf34..48a3d4264 100644
--- a/examples/with-nanostores/README.md
+++ b/examples/with-nanostores/README.md
@@ -1,7 +1,7 @@
# Astro Example: Nanostores
```
-npm init astro --template with-nanostores
+npm init astro -- --template with-nanostores
```
This example showcases using [`nanostores`](https://github.com/nanostores/nanostores) to provide shared state between components from different frameworks.
diff --git a/examples/with-tailwindcss/README.md b/examples/with-tailwindcss/README.md
index d13d4797e..8f5a7064b 100644
--- a/examples/with-tailwindcss/README.md
+++ b/examples/with-tailwindcss/README.md
@@ -1,7 +1,7 @@
# Astro with Tailwind
```
-npm init astro --template with-tailwindcss
+npm init astro -- --template with-tailwindcss
```
Astro comes with [Tailwind](https://tailwindcss.com) support out of the box. This example showcases how to style your Astro project with Tailwind.