diff options
| author |  Okiki <okikio.dev@gmail.com>
| 2021-11-11 14:28:51 -0500 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2021-11-11 13:28:51 -0600 |
| commit | eb4effb6b77f940030110f73a4081b69909a8d5d (patch) | |
| tree | 7f9db8975e3dac52f25e75e7db05d949e9bbe96f /examples/docs/README.md | |
| parent | 529486bfb0d6f0ca54b091b000ed446dd1a085af (diff) | |
| download | astro-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/docs/README.md')
| -rw-r--r-- | examples/docs/README.md | 12 |
1 files changed, 6 insertions, 6 deletions
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. |