summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Laurent Thiebault <thiebault.laurent@gmail.com> 2023-04-18 08:02:40 +0200
committerGravatar GitHub <noreply@github.com> 2023-04-18 08:02:40 +0200
commit0c82e08cece3aca5b1a52ec19286e6476845949e (patch)
treeb73bd70684f336dee7c1f61353ad718e84c04208
parent4c7ba4da084d7508df91cbac03c2b099a8301e2b (diff)
downloadastro-0c82e08cece3aca5b1a52ec19286e6476845949e.tar.gz
astro-0c82e08cece3aca5b1a52ec19286e6476845949e.tar.zst
astro-0c82e08cece3aca5b1a52ec19286e6476845949e.zip
docs: add the right `npm` command regarding `astro --help` for examples' `README.md` files (#6864)
-rw-r--r--examples/basics/README.md16
-rw-r--r--examples/blog/README.md16
-rw-r--r--examples/deno/README.md18
-rw-r--r--examples/docs/README.md16
-rw-r--r--examples/hackernews/README.md16
-rw-r--r--examples/minimal/README.md16
-rw-r--r--examples/non-html-pages/README.md16
-rw-r--r--examples/portfolio/README.md16
-rw-r--r--examples/with-markdoc/README.md16
-rw-r--r--examples/with-vite-plugin-pwa/README.md16
10 files changed, 81 insertions, 81 deletions
diff --git a/examples/basics/README.md b/examples/basics/README.md
index 961e54e87..43c1d6d0c 100644
--- a/examples/basics/README.md
+++ b/examples/basics/README.md
@@ -41,14 +41,14 @@ Any static assets, like images, can be placed in the `public/` directory.
All commands are run from the root of the project, from a terminal:
-| Command | Action |
-| :--------------------- | :----------------------------------------------- |
-| `npm install` | Installs dependencies |
-| `npm run dev` | Starts local dev server at `localhost:3000` |
-| `npm run build` | Build your production site to `./dist/` |
-| `npm run preview` | Preview your build locally, before deploying |
-| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
-| `npm run astro --help` | Get help using the Astro CLI |
+| Command | Action |
+| :------------------------ | :----------------------------------------------- |
+| `npm install` | Installs dependencies |
+| `npm run dev` | Starts local dev server at `localhost:3000` |
+| `npm run build` | Build your production site to `./dist/` |
+| `npm run preview` | Preview your build locally, before deploying |
+| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
+| `npm run astro -- --help` | Get help using the Astro CLI |
## 👀 Want to learn more?
diff --git a/examples/blog/README.md b/examples/blog/README.md
index eae285a3f..579d3244a 100644
--- a/examples/blog/README.md
+++ b/examples/blog/README.md
@@ -51,14 +51,14 @@ Any static assets, like images, can be placed in the `public/` directory.
All commands are run from the root of the project, from a terminal:
-| Command | Action |
-| :--------------------- | :----------------------------------------------- |
-| `npm install` | Installs dependencies |
-| `npm run dev` | Starts local dev server at `localhost:3000` |
-| `npm run build` | Build your production site to `./dist/` |
-| `npm run preview` | Preview your build locally, before deploying |
-| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
-| `npm run astro --help` | Get help using the Astro CLI |
+| Command | Action |
+| :------------------------ | :----------------------------------------------- |
+| `npm install` | Installs dependencies |
+| `npm run dev` | Starts local dev server at `localhost:3000` |
+| `npm run build` | Build your production site to `./dist/` |
+| `npm run preview` | Preview your build locally, before deploying |
+| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
+| `npm run astro -- --help` | Get help using the Astro CLI |
## 👀 Want to learn more?
diff --git a/examples/deno/README.md b/examples/deno/README.md
index c1552c0e3..0b1ea4c4b 100644
--- a/examples/deno/README.md
+++ b/examples/deno/README.md
@@ -40,15 +40,15 @@ Any static assets, like images, can be placed in the `public/` directory.
All commands are run from the root of the project, from a terminal:
-| Command | Action |
-| :--------------------- | :----------------------------------------------- |
-| `npm install` | Installs dependencies |
-| `npm run dev` | Starts local dev server at `localhost:3000` |
-| `npm run build` | Build your production site to `./dist/` |
-| `npm run preview` | Preview your build locally, before deploying |
-| | (preview uses Deno CLI) |
-| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
-| `npm run astro --help` | Get help using the Astro CLI |
+| Command | Action |
+| :------------------------ | :----------------------------------------------- |
+| `npm install` | Installs dependencies |
+| `npm run dev` | Starts local dev server at `localhost:3000` |
+| `npm run build` | Build your production site to `./dist/` |
+| `npm run preview` | Preview your build locally, before deploying |
+| | (preview uses Deno CLI) |
+| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
+| `npm run astro -- --help` | Get help using the Astro CLI |
## 👀 Want to learn more?
diff --git a/examples/docs/README.md b/examples/docs/README.md
index e62e50dd7..adf7f4937 100644
--- a/examples/docs/README.md
+++ b/examples/docs/README.md
@@ -27,14 +27,14 @@ npm create astro@latest -- --template docs
All commands are run from the root of the project, from a terminal:
-| Command | Action |
-| :--------------------- | :----------------------------------------------- |
-| `npm install` | Installs dependencies |
-| `npm run dev` | Starts local dev server at `localhost:3000` |
-| `npm run build` | Build your production site to `./dist/` |
-| `npm run preview` | Preview your build locally, before deploying |
-| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
-| `npm run astro --help` | Get help using the Astro CLI |
+| Command | Action |
+| :------------------------ | :----------------------------------------------- |
+| `npm install` | Installs dependencies |
+| `npm run dev` | Starts local dev server at `localhost:3000` |
+| `npm run build` | Build your production site to `./dist/` |
+| `npm run preview` | Preview your build locally, before deploying |
+| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
+| `npm run astro -- --help` | Get help using the Astro CLI |
To deploy your site to production, check out our [Deploy an Astro Website](https://docs.astro.build/guides/deploy) guide.
diff --git a/examples/hackernews/README.md b/examples/hackernews/README.md
index 677bfebb9..937ad23ea 100644
--- a/examples/hackernews/README.md
+++ b/examples/hackernews/README.md
@@ -45,14 +45,14 @@ This project uses the [`@astrojs/node`](https://docs.astro.build/en/guides/integ
All commands are run from the root of the project, from a terminal:
-| Command | Action |
-| :--------------------- | :----------------------------------------------- |
-| `npm install` | Installs dependencies |
-| `npm run dev` | Starts local dev server at `localhost:3000` |
-| `npm run build` | Build your production site to `./dist/` |
-| `npm run preview` | Preview your build locally, before deploying |
-| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
-| `npm run astro --help` | Get help using the Astro CLI |
+| Command | Action |
+| :------------------------ | :----------------------------------------------- |
+| `npm install` | Installs dependencies |
+| `npm run dev` | Starts local dev server at `localhost:3000` |
+| `npm run build` | Build your production site to `./dist/` |
+| `npm run preview` | Preview your build locally, before deploying |
+| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
+| `npm run astro -- --help` | Get help using the Astro CLI |
## 👀 Want to learn more?
diff --git a/examples/minimal/README.md b/examples/minimal/README.md
index e81359a7d..3c261d317 100644
--- a/examples/minimal/README.md
+++ b/examples/minimal/README.md
@@ -33,14 +33,14 @@ Any static assets, like images, can be placed in the `public/` directory.
All commands are run from the root of the project, from a terminal:
-| Command | Action |
-| :--------------------- | :----------------------------------------------- |
-| `npm install` | Installs dependencies |
-| `npm run dev` | Starts local dev server at `localhost:3000` |
-| `npm run build` | Build your production site to `./dist/` |
-| `npm run preview` | Preview your build locally, before deploying |
-| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
-| `npm run astro --help` | Get help using the Astro CLI |
+| Command | Action |
+| :------------------------ | :----------------------------------------------- |
+| `npm install` | Installs dependencies |
+| `npm run dev` | Starts local dev server at `localhost:3000` |
+| `npm run build` | Build your production site to `./dist/` |
+| `npm run preview` | Preview your build locally, before deploying |
+| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
+| `npm run astro -- --help` | Get help using the Astro CLI |
## 👀 Want to learn more?
diff --git a/examples/non-html-pages/README.md b/examples/non-html-pages/README.md
index 98f0d5f9c..d1caeed41 100644
--- a/examples/non-html-pages/README.md
+++ b/examples/non-html-pages/README.md
@@ -38,14 +38,14 @@ Any static assets, like images, can be placed in the `public/` directory.
All commands are run from the root of the project, from a terminal:
-| Command | Action |
-| :--------------------- | :----------------------------------------------- |
-| `npm install` | Installs dependencies |
-| `npm run dev` | Starts local dev server at `localhost:3000` |
-| `npm run build` | Build your production site to `./dist/` |
-| `npm run preview` | Preview your build locally, before deploying |
-| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
-| `npm run astro --help` | Get help using the Astro CLI |
+| Command | Action |
+| :------------------------ | :----------------------------------------------- |
+| `npm install` | Installs dependencies |
+| `npm run dev` | Starts local dev server at `localhost:3000` |
+| `npm run build` | Build your production site to `./dist/` |
+| `npm run preview` | Preview your build locally, before deploying |
+| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
+| `npm run astro -- --help` | Get help using the Astro CLI |
## 👀 Want to learn more?
diff --git a/examples/portfolio/README.md b/examples/portfolio/README.md
index 510b81297..cc9cdd5e3 100644
--- a/examples/portfolio/README.md
+++ b/examples/portfolio/README.md
@@ -17,14 +17,14 @@ npm create astro@latest -- --template portfolio
All commands are run from the root of the project, from a terminal:
-| Command | Action |
-| :--------------------- | :----------------------------------------------- |
-| `npm install` | Installs dependencies |
-| `npm run dev` | Starts local dev server at `localhost:3000` |
-| `npm run build` | Build your production site to `./dist/` |
-| `npm run preview` | Preview your build locally, before deploying |
-| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
-| `npm run astro --help` | Get help using the Astro CLI |
+| Command | Action |
+| :------------------------ | :----------------------------------------------- |
+| `npm install` | Installs dependencies |
+| `npm run dev` | Starts local dev server at `localhost:3000` |
+| `npm run build` | Build your production site to `./dist/` |
+| `npm run preview` | Preview your build locally, before deploying |
+| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
+| `npm run astro -- --help` | Get help using the Astro CLI |
## 👀 Want to learn more?
diff --git a/examples/with-markdoc/README.md b/examples/with-markdoc/README.md
index b5adbf27b..4f44648da 100644
--- a/examples/with-markdoc/README.md
+++ b/examples/with-markdoc/README.md
@@ -42,14 +42,14 @@ You can also render Astro components from your Markdoc files using [tags](https:
All commands are run from the root of the project, from a terminal:
-| Command | Action |
-| :--------------------- | :----------------------------------------------- |
-| `npm install` | Installs dependencies |
-| `npm run dev` | Starts local dev server at `localhost:3000` |
-| `npm run build` | Build your production site to `./dist/` |
-| `npm run preview` | Preview your build locally, before deploying |
-| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
-| `npm run astro --help` | Get help using the Astro CLI |
+| Command | Action |
+| :------------------------ | :----------------------------------------------- |
+| `npm install` | Installs dependencies |
+| `npm run dev` | Starts local dev server at `localhost:3000` |
+| `npm run build` | Build your production site to `./dist/` |
+| `npm run preview` | Preview your build locally, before deploying |
+| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
+| `npm run astro -- --help` | Get help using the Astro CLI |
## 👀 Want to learn more?
diff --git a/examples/with-vite-plugin-pwa/README.md b/examples/with-vite-plugin-pwa/README.md
index 5ab1bcf98..9c29863db 100644
--- a/examples/with-vite-plugin-pwa/README.md
+++ b/examples/with-vite-plugin-pwa/README.md
@@ -33,14 +33,14 @@ Any static assets, like images, can be placed in the `public/` directory.
All commands are run from the root of the project, from a terminal:
-| Command | Action |
-| :--------------------- | :----------------------------------------------- |
-| `npm install` | Installs dependencies |
-| `npm run dev` | Starts local dev server at `localhost:3000` |
-| `npm run build` | Build your production site to `./dist/` |
-| `npm run preview` | Preview your build locally, before deploying |
-| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
-| `npm run astro --help` | Get help using the Astro CLI |
+| Command | Action |
+| :------------------------ | :----------------------------------------------- |
+| `npm install` | Installs dependencies |
+| `npm run dev` | Starts local dev server at `localhost:3000` |
+| `npm run build` | Build your production site to `./dist/` |
+| `npm run preview` | Preview your build locally, before deploying |
+| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
+| `npm run astro -- --help` | Get help using the Astro CLI |
## 👀 Want to learn more?