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

docs: seperate npm run build and npm run dev to avoid confusion (#1798)

Browse source 
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
This commit is contained in:
Okiki 2021-11-11 14:28:51 -05:00 committed by GitHub
parent 529486bfb0
commit eb4effb6b7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
17 changed files with 65 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/src/pages/de/quick-start.md
View file

@ -19,7 +19,10 @@ npm install
# Fange an zu entwickeln! # Fange an zu entwickeln!
npm run dev npm run dev
```
Für Produktionsstandorte,
```shell
# Wenn du bereit bist: Exportiere deine Seite nach `dist/` # Wenn du bereit bist: Exportiere deine Seite nach `dist/`
npm run build npm run build
``` ```

3
docs/src/pages/es/quick-start.md
View file

@ -19,7 +19,10 @@ npm install
# comienza con el desarrollo # comienza con el desarrollo
npm run dev npm run dev
```
Para los sitios de producción,
```shell
# cuando estés listo: crea tu sitio estático en la carpeta `dist/` # cuando estés listo: crea tu sitio estático en la carpeta `dist/`
npm run build npm run build
``` ```

2
docs/src/pages/fi/quick-start.md
View file

@ -19,7 +19,9 @@ npm install
# aloita kehittäminen! # aloita kehittäminen!
npm run dev npm run dev
```
```shell
# kun olet valmis: luo oma staattinen sivustosi hakemistoon `dist/` # kun olet valmis: luo oma staattinen sivustosi hakemistoon `dist/`
npm run build npm run build
``` ```

2
docs/src/pages/fr/quick-start.md
View file

@ -19,7 +19,9 @@ npm install
# Commencez à coder ! # Commencez à coder !
npm run dev npm run dev
```
```shell
# Quand votre site est fin prêt, compilez-en une version statique dans le dossier `dist/` # Quand votre site est fin prêt, compilez-en une version statique dans le dossier `dist/`
npm run build npm run build
``` ```

2
docs/src/pages/ja/quick-start.md
View file

@ -19,7 +19,9 @@ npm install
# 開発を始めよう # 開発を始めよう
npm run dev npm run dev
```
```shell
# 準備ができたら、`dist/`に静的サイトを構築します。 # 準備ができたら、`dist/`に静的サイトを構築します。
npm run build npm run build
``` ```

2
docs/src/pages/nl/quick-start.md
View file

@ -19,7 +19,9 @@ npm install
# start de ontwikkeling! # start de ontwikkeling!
npm run dev npm run dev
```
```shell
# zodra je klaar bent, bouw dan je website met het volgende commanda # zodra je klaar bent, bouw dan je website met het volgende commanda
npm run build npm run build
``` ```

3
docs/src/pages/quick-start.md
View file

@ -19,7 +19,10 @@ npm install
# start developing! # start developing!
npm run dev npm run dev
```
For production sites,
```shell
# when you're ready: build your static site to `dist/` # when you're ready: build your static site to `dist/`
npm run build npm run build
``` ```

2
docs/src/pages/ru/quick-start.md
View file

@ -18,7 +18,9 @@ npm install
# начинаем разработку! # начинаем разработку!
npm run dev npm run dev
```
```shell
# когда все готово: запустите сборку вашего статического сайта в директорию `dist/` # когда все готово: запустите сборку вашего статического сайта в директорию `dist/`
npm run build npm run build
``` ```

2
docs/src/pages/zh-CN/quick-start.md
View file

@ -19,7 +19,9 @@ npm install
# 启动项目 # 启动项目
npm run dev npm run dev
```
```shell
# 将项目打包到 dist 文件夹下 # 将项目打包到 dist 文件夹下
npm run build npm run build
``` ```

2
docs/src/pages/zh-TW/quick-start.md
View file

@ -19,7 +19,9 @@ npm install
# 開始開發！ # 開始開發！
npm run dev npm run dev
```
```shell
# 做好之後：把靜態網站 build 進 `dist/` # 做好之後：把靜態網站 build 進 `dist/`
npm run build npm run build
``` ```

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

@ -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: All commands are run from the root of the project, from a terminal:
| Command | Action | | Command | Action |
|:----------------|:--------------------------------------------| |:---------------- |:-------------------------------------------- |
| `npm install` | Installs dependencies | | `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:3000` | | `npm run dev` | Starts local dev server at `localhost:3000` |
| `npm run build` | Build your production site to `./dist/` | | `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |
## 👀 Want to learn more? ## 👀 Want to learn more?

11
examples/blog/README.md
View file

@ -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: All commands are run from the root of the project, from a terminal:
| Command | Action | | Command | Action |
|:----------------|:--------------------------------------------| |:---------------- |:-------------------------------------------- |
| `npm install` | Installs dependencies | | `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:3000` | | `npm run dev` | Starts local dev server at `localhost:3000` |
| `npm run build` | Build your production site to `./dist/` | | `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |
## 👀 Want to learn more? ## 👀 Want to learn more?

12
examples/docs/README.md
View file

@ -21,12 +21,12 @@ npm init astro -- --template docs
All commands are run from the root of the project, from a terminal: All commands are run from the root of the project, from a terminal:
| Command | Action | | Command | Action |
|:-----------------|:---------------------------------------------| |:---------------- |:-------------------------------------------- |
| `npm install` | Installs dependencies | | `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:3000` | | `npm run dev` | Starts local dev server at `localhost:3000` |
| `npm run build` | Build your production site to `./dist/` | | `npm run build` | Build your production site to `./dist/` |
| `npm run preview`| Preview your build locally, before deploying | | `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. To deploy your site to production, check out our [Deploy an Astro Website](https://docs.astro.build/guides/deploy) guide.

11
examples/minimal/README.md
View file

@ -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: All commands are run from the root of the project, from a terminal:
| Command | Action | | Command | Action |
|:----------------|:--------------------------------------------| |:---------------- |:-------------------------------------------- |
| `npm install` | Installs dependencies | | `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:3000` | | `npm run dev` | Starts local dev server at `localhost:3000` |
| `npm run build` | Build your production site to `./dist/` | | `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |
## 👀 Want to learn more? ## 👀 Want to learn more?

11
examples/portfolio-svelte/README.md
View file

@ -12,11 +12,12 @@ npm init astro -- --template portfolio
All commands are run from the root of the project, from a terminal: All commands are run from the root of the project, from a terminal:
| Command | Action | | Command | Action |
|:----------------|:--------------------------------------------| |:---------------- |:-------------------------------------------- |
| `npm install` | Installs dependencies | | `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:3000` | | `npm run dev` | Starts local dev server at `localhost:3000` |
| `npm run build` | Build your production site to `./dist/` | | `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |
## 👀 Want to learn more? ## 👀 Want to learn more?

11
examples/portfolio/README.md
View file

@ -12,11 +12,12 @@ npm init astro -- --template portfolio
All commands are run from the root of the project, from a terminal: All commands are run from the root of the project, from a terminal:
| Command | Action | | Command | Action |
|:----------------|:--------------------------------------------| |:---------------- |:-------------------------------------------- |
| `npm install` | Installs dependencies | | `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:3000` | | `npm run dev` | Starts local dev server at `localhost:3000` |
| `npm run build` | Build your production site to `./dist/` | | `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |
## 👀 Want to learn more? ## 👀 Want to learn more?

11
examples/starter/README.md
View file

@ -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: All commands are run from the root of the project, from a terminal:
| Command | Action | | Command | Action |
|:----------------|:--------------------------------------------| |:---------------- |:-------------------------------------------- |
| `npm install` | Installs dependencies | | `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:3000` | | `npm run dev` | Starts local dev server at `localhost:3000` |
| `npm run build` | Build your production site to `./dist/` | | `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |
## 👀 Want to learn more? ## 👀 Want to learn more?