0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-23 21:53:55 -05:00
astro/examples
Okiki eb4effb6b7
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
2021-11-11 13:28:51 -06:00
..
blog docs: seperate npm run build and npm run dev to avoid confusion (#1798) 2021-11-11 13:28:51 -06:00
blog-multiple-authors docs: seperate npm run build and npm run dev to avoid confusion (#1798) 2021-11-11 13:28:51 -06:00
docs docs: seperate npm run build and npm run dev to avoid confusion (#1798) 2021-11-11 13:28:51 -06:00
framework-lit Version Packages (next) (#1791) 2021-11-11 08:48:04 -05:00
framework-multiple Version Packages (next) (#1791) 2021-11-11 08:48:04 -05:00
framework-preact Version Packages (next) (#1791) 2021-11-11 08:48:04 -05:00
framework-react Version Packages (next) (#1791) 2021-11-11 08:48:04 -05:00
framework-solid Version Packages (next) (#1791) 2021-11-11 08:48:04 -05:00
framework-svelte Version Packages (next) (#1791) 2021-11-11 08:48:04 -05:00
framework-vue Version Packages (next) (#1791) 2021-11-11 08:48:04 -05:00
minimal docs: seperate npm run build and npm run dev to avoid confusion (#1798) 2021-11-11 13:28:51 -06:00
portfolio docs: seperate npm run build and npm run dev to avoid confusion (#1798) 2021-11-11 13:28:51 -06:00
portfolio-svelte docs: seperate npm run build and npm run dev to avoid confusion (#1798) 2021-11-11 13:28:51 -06:00
starter docs: seperate npm run build and npm run dev to avoid confusion (#1798) 2021-11-11 13:28:51 -06:00
with-markdown Version Packages (next) (#1791) 2021-11-11 08:48:04 -05:00
with-markdown-plugins Version Packages (next) (#1791) 2021-11-11 08:48:04 -05:00
with-nanostores Version Packages (next) (#1791) 2021-11-11 08:48:04 -05:00
with-tailwindcss Version Packages (next) (#1791) 2021-11-11 08:48:04 -05:00
README.md Docs: npm@7 requires an extra -- for arguments passed to the command, per @natemoo-re's description. (#786) 2021-07-20 20:06:11 -05:00

Astro Examples Library

The easiest way to check out one of these examples on your machine is by running this command in an empty directory:

npm init astro -- --template [EXAMPLE_NAME]

Community Examples

Visit awesome-astro for a full list of community examples. You can use npm init astro to check out any community examples:

npm init astro -- --template [GITHUB_USER]/[REPO_NAME]

Paths to examples nested inside of a repo are also supported:

npm init astro -- --template [GITHUB_USER]/[REPO_NAME]/path/to/example