summaryrefslogtreecommitdiff
path: root/examples/docs
diff options
context:
space:
mode:
authorGravatar Fred K. Schott <fkschott@gmail.com> 2022-08-05 21:36:23 -0700
committerGravatar GitHub <noreply@github.com> 2022-08-05 21:36:23 -0700
commit3f3a293b6bbb6bcadf2a88633efe9dbac26fb438 (patch)
tree912bff1df32e403f95f56de68620f96c38d33be5 /examples/docs
parentd344f9e3ec1f69ad4d7efd433b3523ad5413b726 (diff)
downloadastro-3f3a293b6bbb6bcadf2a88633efe9dbac26fb438.tar.gz
astro-3f3a293b6bbb6bcadf2a88633efe9dbac26fb438.tar.zst
astro-3f3a293b6bbb6bcadf2a88633efe9dbac26fb438.zip
update example scripts (#4098)
Diffstat (limited to 'examples/docs')
-rw-r--r--examples/docs/README.md14
-rw-r--r--examples/docs/package.json3
2 files changed, 10 insertions, 7 deletions
diff --git a/examples/docs/README.md b/examples/docs/README.md
index bbaa492cd..447390ae9 100644
--- a/examples/docs/README.md
+++ b/examples/docs/README.md
@@ -21,12 +21,14 @@ 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 |
+| `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/docs/package.json b/examples/docs/package.json
index 2ec27dc10..5f861e4de 100644
--- a/examples/docs/package.json
+++ b/examples/docs/package.json
@@ -6,7 +6,8 @@
"dev": "astro dev",
"start": "astro dev",
"build": "astro build",
- "preview": "astro preview"
+ "preview": "astro preview",
+ "astro": "astro"
},
"dependencies": {
"@algolia/client-search": "^4.13.1",