summaryrefslogtreecommitdiff
path: root/examples
diff options
context:
space:
mode:
authorGravatar Okiki <okikio.dev@gmail.com> 2021-11-11 14:28:51 -0500
committerGravatar GitHub <noreply@github.com> 2021-11-11 13:28:51 -0600
commiteb4effb6b77f940030110f73a4081b69909a8d5d (patch)
tree7f9db8975e3dac52f25e75e7db05d949e9bbe96f /examples
parent529486bfb0d6f0ca54b091b000ed446dd1a085af (diff)
downloadastro-eb4effb6b77f940030110f73a4081b69909a8d5d.tar.gz
astro-eb4effb6b77f940030110f73a4081b69909a8d5d.tar.zst
astro-eb4effb6b77f940030110f73a4081b69909a8d5d.zip
docs: seperate `npm run build` and `npm run dev` to avoid confusion (#1798)
To avoid confusion I seperated the `npm run build` and the `npm run dev` commands, beginners might get confused by each command being listed in the same list, thinking they need to run `npm run build` before Astro works properly. Add `npm run preview` commands to all examples where they are missing
Diffstat (limited to 'examples')
-rw-r--r--examples/blog-multiple-authors/README.md11
-rw-r--r--examples/blog/README.md11
-rw-r--r--examples/docs/README.md12
-rw-r--r--examples/minimal/README.md11
-rw-r--r--examples/portfolio-svelte/README.md11
-rw-r--r--examples/portfolio/README.md11
-rw-r--r--examples/starter/README.md11
7 files changed, 42 insertions, 36 deletions
diff --git a/examples/blog-multiple-authors/README.md b/examples/blog-multiple-authors/README.md
index 53c9af60a..23aad66f2 100644
--- a/examples/blog-multiple-authors/README.md
+++ b/examples/blog-multiple-authors/README.md
@@ -42,11 +42,12 @@ 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/` |
+| 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 |
## 👀 Want to learn more?
diff --git a/examples/blog/README.md b/examples/blog/README.md
index d01ff471a..15d7b3fae 100644
--- a/examples/blog/README.md
+++ b/examples/blog/README.md
@@ -42,11 +42,12 @@ 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/` |
+| 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 |
## 👀 Want to learn more?
diff --git a/examples/docs/README.md b/examples/docs/README.md
index 83865d782..cd78f9495 100644
--- a/examples/docs/README.md
+++ b/examples/docs/README.md
@@ -21,12 +21,12 @@ npm init astro -- --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 |
+| 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 |
To deploy your site to production, check out our [Deploy an Astro Website](https://docs.astro.build/guides/deploy) guide.
diff --git a/examples/minimal/README.md b/examples/minimal/README.md
index b1284d33b..b078cf708 100644
--- a/examples/minimal/README.md
+++ b/examples/minimal/README.md
@@ -31,11 +31,12 @@ 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/` |
+| 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 |
## 👀 Want to learn more?
diff --git a/examples/portfolio-svelte/README.md b/examples/portfolio-svelte/README.md
index d90b69d0f..b40609c3e 100644
--- a/examples/portfolio-svelte/README.md
+++ b/examples/portfolio-svelte/README.md
@@ -12,11 +12,12 @@ npm init astro -- --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/` |
+| 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 |
## 👀 Want to learn more?
diff --git a/examples/portfolio/README.md b/examples/portfolio/README.md
index 6a32943e7..7d5a5a8e7 100644
--- a/examples/portfolio/README.md
+++ b/examples/portfolio/README.md
@@ -12,11 +12,12 @@ npm init astro -- --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/` |
+| 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 |
## 👀 Want to learn more?
diff --git a/examples/starter/README.md b/examples/starter/README.md
index 1b16a8273..69a776bf5 100644
--- a/examples/starter/README.md
+++ b/examples/starter/README.md
@@ -31,11 +31,12 @@ 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/` |
+| 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 |
## 👀 Want to learn more?