michael/astro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Docs: npm@7 requires an extra -- for arguments passed to the command, per @natemoo-re's description. (#786)

Browse source
This commit is contained in:
Caleb Jasik 2021-07-20 20:06:11 -05:00 committed by GitHub
parent c1e304dfb8
commit 8eeb6b4fe8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
examples/README.md
View file

@ -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: 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 ## 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: 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: 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
``` ```

2
examples/blog-multiple-authors/README.md
View file

@ -1,7 +1,7 @@
# Astro Starter Kit: Blog with Multiple Authors # 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! > 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!

2
examples/blog/README.md
View file

@ -1,7 +1,7 @@
# Astro Starter Kit: Blog # Astro Starter Kit: Blog
``` ```
npm init astro --template blog npm init astro -- --template blog
``` ```
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! > 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!

2
examples/docs/README.md
View file

@ -1,7 +1,7 @@
# Astro Starter Kit: Docs Site # Astro Starter Kit: Docs Site
``` ```
npm init astro --template docs npm init astro -- --template docs
``` ```
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! > 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!

2
examples/framework-multiple/README.md
View file

@ -1,7 +1,7 @@
# Kitchen Sink: Microfrontends with Astro # 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/)). 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/)).

2
examples/framework-preact/README.md
View file

@ -1,7 +1,7 @@
# Using Preact with Astro # 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/). This example showcases Astro's built-in support for [Preact](https://preactjs.com/).

2
examples/framework-react/README.md
View file

@ -1,7 +1,7 @@
# Using React with Astro # 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/). This example showcases Astro's built-in support for [React](https://reactjs.org/).

2
examples/framework-svelte/README.md
View file

@ -1,7 +1,7 @@
# Using Svelte with Astro # 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/). This example showcases Astro's built-in support for [Svelte](https://svelte.dev/).

2
examples/framework-vue/README.md
View file

@ -1,7 +1,7 @@
# Using Vue with Astro # 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/). This example showcases Astro's built-in support for [Vue (`v3.x`)](https://v3.vuejs.org/).

2
examples/portfolio/README.md
View file

@ -1,7 +1,7 @@
# Astro Starter Kit: Portfolio # Astro Starter Kit: Portfolio
``` ```
npm init astro --template portfolio npm init astro -- --template portfolio
``` ```
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! > 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!

2
examples/with-markdown/README.md
View file

@ -1,7 +1,7 @@
# Astro Example: Markdown # 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). This example showcases Astro's [built-in Markdown support](../../docs/markdown.md).

2
examples/with-nanostores/README.md
View file

@ -1,7 +1,7 @@
# Astro Example: Nanostores # 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. This example showcases using [`nanostores`](https://github.com/nanostores/nanostores) to provide shared state between components from different frameworks.

2
examples/with-tailwindcss/README.md
View file

@ -1,7 +1,7 @@
# Astro with Tailwind # 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. Astro comes with [Tailwind](https://tailwindcss.com) support out of the box. This example showcases how to style your Astro project with Tailwind.