michael/astro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

update example scripts (#4098)

Browse source
This commit is contained in:
Fred K. Schott 2022-08-05 21:36:23 -07:00 committed by GitHub
parent d344f9e3ec
commit 3f3a293b6b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
34 changed files with 121 additions and 77 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
examples/basics/README.md
View file

@ -30,12 +30,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: All commands are run from the root of the project, from a terminal:
| Command | Action | | Command | Action |
| :---------------- | :------------------------------------------- | | :--------------------- | :------------------------------------------------- |
| `npm install` | Installs dependencies | | `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:3000` | | `npm run dev` | Starts local dev server at `localhost:3000` |
| `npm run build` | Build your production site to `./dist/` | | `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying | | `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 |
## 👀 Want to learn more? ## 👀 Want to learn more?

3
examples/basics/package.json
View file

@ -6,7 +6,8 @@
"dev": "astro dev", "dev": "astro dev",
"start": "astro dev", "start": "astro dev",
"build": "astro build", "build": "astro build",
"preview": "astro preview" "preview": "astro preview",
"astro": "astro"
}, },
"devDependencies": { "devDependencies": {
"astro": "^1.0.0-rc.6" "astro": "^1.0.0-rc.6"

14
examples/blog/README.md
View file

@ -58,12 +58,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: All commands are run from the root of the project, from a terminal:
| Command | Action | | Command | Action |
| :---------------- | :------------------------------------------- | | :--------------------- | :----------------------------------------------- |
| `npm install` | Installs dependencies | | `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:3000` | | `npm run dev` | Starts local dev server at `localhost:3000` |
| `npm run build` | Build your production site to `./dist/` | | `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying | | `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? ## 👀 Want to learn more?

3
examples/blog/package.json
View file

@ -6,7 +6,8 @@
"dev": "astro dev", "dev": "astro dev",
"start": "astro dev", "start": "astro dev",
"build": "astro build", "build": "astro build",
"preview": "astro preview" "preview": "astro preview",
"astro": "astro"
}, },
"devDependencies": { "devDependencies": {
"@astrojs/preact": "^0.5.2", "@astrojs/preact": "^0.5.2",

14
examples/component/README.md
View file

@ -33,12 +33,14 @@ This project uses **workspaces** to develop a single package, `@example/my-compo
All commands are run from the root of the project, from a terminal: All commands are run from the root of the project, from a terminal:
| Command | Action | | Command | Action |
|:---------------- |:-------------------------------------------- | | :--------------------- | :----------------------------------------------- |
| `npm install` | Installs dependencies | | `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:3000` | | `npm run dev` | Starts local dev server at `localhost:3000` |
| `npm run build` | Build your production site to `./dist/` | | `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying | | `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? ## 👀 Want to learn more?

3
examples/component/demo/package.json
View file

@ -6,7 +6,8 @@
"dev": "astro dev", "dev": "astro dev",
"start": "astro dev", "start": "astro dev",
"build": "astro build", "build": "astro build",
"preview": "astro preview" "preview": "astro preview",
"astro": "astro"
}, },
"devDependencies": { "devDependencies": {
"@example/my-component": "workspace:*", "@example/my-component": "workspace:*",

14
examples/docs/README.md
View file

@ -21,12 +21,14 @@ npm init astro -- --template docs
All commands are run from the root of the project, from a terminal: All commands are run from the root of the project, from a terminal:
| Command | Action | | Command | Action |
| :---------------- | :------------------------------------------- | | :--------------------- | :----------------------------------------------- |
| `npm install` | Installs dependencies | | `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:3000` | | `npm run dev` | Starts local dev server at `localhost:3000` |
| `npm run build` | Build your production site to `./dist/` | | `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying | | `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. To deploy your site to production, check out our [Deploy an Astro Website](https://docs.astro.build/guides/deploy) guide.

3
examples/docs/package.json
View file

@ -6,7 +6,8 @@
"dev": "astro dev", "dev": "astro dev",
"start": "astro dev", "start": "astro dev",
"build": "astro build", "build": "astro build",
"preview": "astro preview" "preview": "astro preview",
"astro": "astro"
}, },
"dependencies": { "dependencies": {
"@algolia/client-search": "^4.13.1", "@algolia/client-search": "^4.13.1",

3
examples/env-vars/package.json
View file

@ -6,7 +6,8 @@
"dev": "astro dev", "dev": "astro dev",
"start": "astro dev", "start": "astro dev",
"build": "astro build", "build": "astro build",
"preview": "astro preview" "preview": "astro preview",
"astro": "astro"
}, },
"devDependencies": { "devDependencies": {
"astro": "^1.0.0-rc.6" "astro": "^1.0.0-rc.6"

3
examples/framework-alpine/package.json
View file

@ -6,7 +6,8 @@
"dev": "astro dev", "dev": "astro dev",
"start": "astro dev", "start": "astro dev",
"build": "astro build", "build": "astro build",
"preview": "astro preview" "preview": "astro preview",
"astro": "astro"
}, },
"devDependencies": { "devDependencies": {
"@types/alpinejs": "^3.7.0", "@types/alpinejs": "^3.7.0",

3
examples/framework-lit/package.json
View file

@ -6,7 +6,8 @@
"dev": "astro dev", "dev": "astro dev",
"start": "astro dev", "start": "astro dev",
"build": "astro build", "build": "astro build",
"preview": "astro preview" "preview": "astro preview",
"astro": "astro"
}, },
"devDependencies": { "devDependencies": {
"@astrojs/lit": "^0.3.2", "@astrojs/lit": "^0.3.2",

3
examples/framework-multiple/package.json
View file

@ -6,7 +6,8 @@
"dev": "astro dev", "dev": "astro dev",
"start": "astro dev", "start": "astro dev",
"build": "astro build", "build": "astro build",
"preview": "astro preview" "preview": "astro preview",
"astro": "astro"
}, },
"devDependencies": { "devDependencies": {
"@astrojs/preact": "^0.5.2", "@astrojs/preact": "^0.5.2",

3
examples/framework-preact/package.json
View file

@ -6,7 +6,8 @@
"dev": "astro dev", "dev": "astro dev",
"start": "astro dev", "start": "astro dev",
"build": "astro build", "build": "astro build",
"preview": "astro preview" "preview": "astro preview",
"astro": "astro"
}, },
"devDependencies": { "devDependencies": {
"@astrojs/preact": "^0.5.2", "@astrojs/preact": "^0.5.2",

3
examples/framework-react/package.json
View file

@ -6,7 +6,8 @@
"dev": "astro dev", "dev": "astro dev",
"start": "astro dev", "start": "astro dev",
"build": "astro build", "build": "astro build",
"preview": "astro preview" "preview": "astro preview",
"astro": "astro"
}, },
"devDependencies": { "devDependencies": {
"@astrojs/react": "^0.4.2", "@astrojs/react": "^0.4.2",

3
examples/framework-solid/package.json
View file

@ -6,7 +6,8 @@
"dev": "astro dev", "dev": "astro dev",
"start": "astro dev", "start": "astro dev",
"build": "astro build", "build": "astro build",
"preview": "astro preview" "preview": "astro preview",
"astro": "astro"
}, },
"devDependencies": { "devDependencies": {
"@astrojs/solid-js": "^0.4.1", "@astrojs/solid-js": "^0.4.1",

3
examples/framework-svelte/package.json
View file

@ -6,7 +6,8 @@
"dev": "astro dev", "dev": "astro dev",
"start": "astro dev", "start": "astro dev",
"build": "astro build", "build": "astro build",
"preview": "astro preview" "preview": "astro preview",
"astro": "astro"
}, },
"devDependencies": { "devDependencies": {
"@astrojs/svelte": "^0.5.1", "@astrojs/svelte": "^0.5.1",

3
examples/framework-vue/package.json
View file

@ -6,7 +6,8 @@
"dev": "astro dev", "dev": "astro dev",
"start": "astro dev", "start": "astro dev",
"build": "astro build", "build": "astro build",
"preview": "astro preview" "preview": "astro preview",
"astro": "astro"
}, },
"devDependencies": { "devDependencies": {
"@astrojs/vue": "^0.5.0", "@astrojs/vue": "^0.5.0",

14
examples/minimal/README.md
View file

@ -31,12 +31,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: All commands are run from the root of the project, from a terminal:
| Command | Action | | Command | Action |
|:---------------- |:-------------------------------------------- | | :--------------------- | :----------------------------------------------- |
| `npm install` | Installs dependencies | | `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:3000` | | `npm run dev` | Starts local dev server at `localhost:3000` |
| `npm run build` | Build your production site to `./dist/` | | `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying | | `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? ## 👀 Want to learn more?

3
examples/minimal/package.json
View file

@ -6,7 +6,8 @@
"dev": "astro dev", "dev": "astro dev",
"start": "astro dev", "start": "astro dev",
"build": "astro build", "build": "astro build",
"preview": "astro preview" "preview": "astro preview",
"astro": "astro"
}, },
"devDependencies": { "devDependencies": {
"astro": "^1.0.0-rc.6" "astro": "^1.0.0-rc.6"

14
examples/non-html-pages/README.md
View file

@ -36,12 +36,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: All commands are run from the root of the project, from a terminal:
| Command | Action | | Command | Action |
|:---------------- |:-------------------------------------------- | | :--------------------- | :----------------------------------------------- |
| `npm install` | Installs dependencies | | `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:3000` | | `npm run dev` | Starts local dev server at `localhost:3000` |
| `npm run build` | Build your production site to `./dist/` | | `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying | | `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? ## 👀 Want to learn more?

3
examples/non-html-pages/package.json
View file

@ -6,7 +6,8 @@
"dev": "astro dev", "dev": "astro dev",
"start": "astro dev", "start": "astro dev",
"build": "astro build", "build": "astro build",
"preview": "astro preview" "preview": "astro preview",
"astro": "astro"
}, },
"devDependencies": { "devDependencies": {
"astro": "^1.0.0-rc.6" "astro": "^1.0.0-rc.6"

14
examples/portfolio/README.md
View file

@ -12,12 +12,14 @@ npm init astro -- --template portfolio
All commands are run from the root of the project, from a terminal: All commands are run from the root of the project, from a terminal:
| Command | Action | | Command | Action |
|:---------------- |:-------------------------------------------- | | :--------------------- | :----------------------------------------------- |
| `npm install` | Installs dependencies | | `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:3000` | | `npm run dev` | Starts local dev server at `localhost:3000` |
| `npm run build` | Build your production site to `./dist/` | | `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying | | `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? ## 👀 Want to learn more?

3
examples/portfolio/package.json
View file

@ -6,7 +6,8 @@
"dev": "astro dev", "dev": "astro dev",
"start": "astro dev", "start": "astro dev",
"build": "astro build", "build": "astro build",
"preview": "astro preview" "preview": "astro preview",
"astro": "astro"
}, },
"devDependencies": { "devDependencies": {
"@astrojs/preact": "^0.5.2", "@astrojs/preact": "^0.5.2",

2
examples/ssr/package.json
View file

@ -6,6 +6,8 @@
"dev": "astro dev", "dev": "astro dev",
"start": "astro dev", "start": "astro dev",
"build": "astro build", "build": "astro build",
"preview": "astro preview",
"astro": "astro",
"server": "node server/server.mjs" "server": "node server/server.mjs"
}, },
"devDependencies": { "devDependencies": {

14
examples/subpath/README.md
View file

@ -33,12 +33,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: All commands are run from the root of the project, from a terminal:
| Command | Action | | Command | Action |
|:---------------- |:-------------------------------------------- | | :--------------------- | :----------------------------------------------- |
| `npm install` | Installs dependencies | | `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:3000` | | `npm run dev` | Starts local dev server at `localhost:3000` |
| `npm run build` | Build your production site to `./dist/` | | `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying | | `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? ## 👀 Want to learn more?

3
examples/subpath/package.json
View file

@ -6,7 +6,8 @@
"dev": "astro dev", "dev": "astro dev",
"start": "astro dev", "start": "astro dev",
"build": "astro build", "build": "astro build",
"preview": "astro preview" "preview": "astro preview",
"astro": "astro"
}, },
"devDependencies": { "devDependencies": {
"@astrojs/react": "^0.4.2", "@astrojs/react": "^0.4.2",

3
examples/with-markdown-plugins/package.json
View file

@ -6,7 +6,8 @@
"dev": "astro dev", "dev": "astro dev",
"start": "astro dev", "start": "astro dev",
"build": "astro build", "build": "astro build",
"preview": "astro preview" "preview": "astro preview",
"astro": "astro"
}, },
"devDependencies": { "devDependencies": {
"@astrojs/markdown-remark": "^0.14.0", "@astrojs/markdown-remark": "^0.14.0",

3
examples/with-markdown-shiki/package.json
View file

@ -6,7 +6,8 @@
"dev": "astro dev", "dev": "astro dev",
"start": "astro dev", "start": "astro dev",
"build": "astro build", "build": "astro build",
"preview": "astro preview" "preview": "astro preview",
"astro": "astro"
}, },
"devDependencies": { "devDependencies": {
"@astrojs/markdown-remark": "^0.14.0", "@astrojs/markdown-remark": "^0.14.0",

3
examples/with-mdx/package.json
View file

@ -6,7 +6,8 @@
"dev": "astro dev", "dev": "astro dev",
"start": "astro dev", "start": "astro dev",
"build": "astro build", "build": "astro build",
"preview": "astro preview" "preview": "astro preview",
"astro": "astro"
}, },
"devDependencies": { "devDependencies": {
"@astrojs/mdx": "^0.6.0", "@astrojs/mdx": "^0.6.0",

3
examples/with-nanostores/package.json
View file

@ -6,7 +6,8 @@
"dev": "astro dev", "dev": "astro dev",
"start": "astro dev", "start": "astro dev",
"build": "astro build", "build": "astro build",
"preview": "astro preview" "preview": "astro preview",
"astro": "astro"
}, },
"dependencies": { "dependencies": {
"@nanostores/preact": "^0.1.3", "@nanostores/preact": "^0.1.3",

3
examples/with-tailwindcss/package.json
View file

@ -6,7 +6,8 @@
"dev": "astro dev", "dev": "astro dev",
"start": "astro dev", "start": "astro dev",
"build": "astro build", "build": "astro build",
"preview": "astro preview" "preview": "astro preview",
"astro": "astro"
}, },
"devDependencies": { "devDependencies": {
"@astrojs/tailwind": "^0.2.5", "@astrojs/tailwind": "^0.2.5",

14
examples/with-vite-plugin-pwa/README.md
View file

@ -31,12 +31,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: All commands are run from the root of the project, from a terminal:
| Command | Action | | Command | Action |
|:---------------- |:-------------------------------------------- | | :--------------------- | :----------------------------------------------- |
| `npm install` | Installs dependencies | | `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:3000` | | `npm run dev` | Starts local dev server at `localhost:3000` |
| `npm run build` | Build your production site to `./dist/` | | `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying | | `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? ## 👀 Want to learn more?

3
examples/with-vite-plugin-pwa/package.json
View file

@ -6,7 +6,8 @@
"dev": "astro dev", "dev": "astro dev",
"start": "astro dev", "start": "astro dev",
"build": "astro build", "build": "astro build",
"preview": "astro preview" "preview": "astro preview",
"astro": "astro"
}, },
"devDependencies": { "devDependencies": {
"astro": "^1.0.0-rc.6", "astro": "^1.0.0-rc.6",

1
examples/with-vitest/package.json
View file

@ -8,6 +8,7 @@
"start": "astro dev", "start": "astro dev",
"build": "astro build", "build": "astro build",
"preview": "astro preview", "preview": "astro preview",
"astro": "astro",
"test": "vitest" "test": "vitest"
}, },
"devDependencies": { "devDependencies": {