Make examples more consistent (#5201)

* Don't ignore `.output` From packages/integrations/vercel/CHANGELOG.md#minor-changes-5: > The output folder changed from `.output` to `.vercel/output` — you may need to update your `.gitignore`. * Make example readmes more consistent * remove `astro check` command Co-authored-by: Nate Moore <[email protected]>
withastro · Jan 26, 2023 · d47a907 · d47a907
1 parent 088f519
commit d47a907
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 26 deletions.
diff --git a/examples/basics/.gitignore b/examples/basics/.gitignore
@@ -1,6 +1,6 @@
 # build output
 dist/
-.output/
+
 # generated types
 .astro/
 
@@ -13,7 +13,6 @@ yarn-debug.log*
 yarn-error.log*
 pnpm-debug.log*
 
-
 # environment variables
 .env
 .env.production

diff --git a/examples/basics/README.md b/examples/basics/README.md
@@ -1,4 +1,8 @@
-# Welcome to [Astro](https://astro.build)
+# Astro Starter Kit: Basics
+
+```
+npm create astro@latest -- --template basics
+```
 
 [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics)
 [![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/s/github/withastro/astro/tree/latest/examples/basics)
@@ -36,14 +40,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 preview` |
-| `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
@@ -1,8 +1,12 @@
-# Welcome to [Astro](https://astro.build)
+# Astro Starter Kit: Deno
 
 [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/deno)
 [![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/s/github/withastro/astro/tree/latest/examples/deno)
 
+```
+npm create astro@latest -- --template deno
+```
+
 > 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
 
 ![basics](https://user-images.githubusercontent.com/4677417/186188965-73453154-fdec-4d6b-9c34-cb35c248ae5b.png)
@@ -35,15 +39,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 preview` |
-| `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
@@ -7,6 +7,8 @@ npm create astro@latest -- --template docs
 [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/docs)
 [![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/s/github/withastro/astro/tree/latest/examples/docs)
 
+> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
+
 ![docs](https://user-images.githubusercontent.com/4677417/186189283-0831b9ab-d6b9-485d-8955-3057e532ab31.png)
 
 
@@ -21,7 +23,7 @@ npm create astro@latest -- --template docs
 - ✅ **Automatic list of contributors**
 - ✅ (and, best of all) **dark mode**
 
-## Commands Cheatsheet
+## 🧞 Commands
 
 All commands are run from the root of the project, from a terminal:
 
@@ -36,9 +38,9 @@ All commands are run from the root of the project, from a terminal:
 
 To deploy your site to production, check out our [Deploy an Astro Website](https://docs.astro.build/guides/deploy) guide.
 
-## New to Astro?
+## 👀 Want to learn more?
 
-Welcome! Check out [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
+Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
 
 ## Customize This Theme
 

diff --git a/examples/docs/package.json b/examples/docs/package.json
@@ -6,7 +6,6 @@
   "scripts": {
     "dev": "astro dev",
     "start": "astro dev",
-    "check": "astro check && tsc",
     "build": "astro build",
     "preview": "astro preview",
     "astro": "astro"

diff --git a/examples/hackernews/package.json b/examples/hackernews/package.json
@@ -6,7 +6,6 @@
   "scripts": {
     "dev": "astro dev",
     "start": "astro dev",
-    "check": "astro check && tsc",
     "build": "astro build",
     "preview": "astro preview",
     "astro": "astro"