diff options
Diffstat (limited to 'examples')
| -rw-r--r-- | examples/basics/.gitignore | 3 | ||||
| -rw-r--r-- | examples/basics/README.md | 22 | ||||
| -rw-r--r-- | examples/deno/README.md | 24 | ||||
| -rw-r--r-- | examples/docs/README.md | 8 | ||||
| -rw-r--r-- | examples/docs/package.json | 1 | ||||
| -rw-r--r-- | examples/hackernews/package.json | 1 |
6 files changed, 33 insertions, 26 deletions
diff --git a/examples/basics/.gitignore b/examples/basics/.gitignore index cfc68ec19..6d4c0aa06 100644 --- 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 index 8252739a4..ff315bae0 100644 --- 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 +``` [](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics) [](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 index 99ef50b59..c7d480b78 100644 --- a/examples/deno/README.md +++ b/examples/deno/README.md @@ -1,8 +1,12 @@ -# Welcome to [Astro](https://astro.build) +# Astro Starter Kit: Deno [](https://stackblitz.com/github/withastro/astro/tree/latest/examples/deno) [](https://codesandbox.io/s/github/withastro/astro/tree/latest/examples/deno) +``` +npm create astro@latest -- --template deno +``` + > 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!  @@ -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 index 79f01419b..f7c44619b 100644 --- a/examples/docs/README.md +++ b/examples/docs/README.md @@ -7,6 +7,8 @@ npm create astro@latest -- --template docs [](https://stackblitz.com/github/withastro/astro/tree/latest/examples/docs) [](https://codesandbox.io/s/github/withastro/astro/tree/latest/examples/docs) +> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun! +  @@ -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 index 943475371..491604598 100644 --- 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 index e37364bfd..8b8e9285f 100644 --- 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" |