update example readmes (#591)

* update example readmes

* Update README.md
This commit is contained in:
Fred K. Schott 2021-07-01 05:43:25 -07:00 committed by GitHub
parent 8f74b3bdbb
commit 67ef02534f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 94 additions and 11 deletions

View file

@ -1,4 +1,8 @@
# Astro Blog Example
# Astro Starter Kit: Blog with Multiple Authors
```
npm init astro --template blog-multiple-authors
```
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!

View file

@ -1,4 +1,8 @@
# Astro Blog Example
# Astro Starter Kit: Blog
```
npm init astro --template blog
```
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!

28
examples/docs/README.md Normal file
View file

@ -0,0 +1,28 @@
# Astro Starter Kit: Docs Site
```
npm init astro --template docs
```
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
Features:
- ✅ CSS Grid Layout
- ✅ Full Markdown support
- ✅ Automatic header navigation sidebar
- ✅ Dark mode enabled by default
## 🧞 Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
|:----------------|:--------------------------------------------|
| `npm install` | Installs dependencies |
| `npm run start` | Starts local dev server at `localhost:3000` |
| `npm run build` | Build your production site to `./dist/` |
## 👀 Want to learn more?
Feel free to check [our documentation](https://github.com/snowpackjs/astro) or jump into our [Discord server](https://astro.build/chat).

View file

@ -1,4 +1,8 @@
# Using Preact with Astro
# Kitchen Sink: Microfrontends with Astro
```
npm init astro --template framework-multiple
```
This example showcases Astro's built-in support for multiple frameworks ([React](https://reactjs.org), [Preact](https://preactjs.com), [Svelte](https://svelte.dev), and [Vue (`v3.x`)](https://v3.vuejs.org/)).

View file

@ -1,5 +1,9 @@
# Using Preact with Astro
```
npm init astro --template framework-preact
```
This example showcases Astro's built-in support for [Preact](https://preactjs.com/).
No configuration is needed to enable Preact support—just start writing Preact components in `src/components`.

View file

@ -1,5 +1,9 @@
# Using React with Astro
```
npm init astro --template framework-react
```
This example showcases Astro's built-in support for [React](https://reactjs.org/).
No configuration is needed to enable React support—just start writing React components in `src/components`.

View file

@ -1,5 +1,9 @@
# Using Svelte with Astro
```
npm init astro --template framework-svelte
```
This example showcases Astro's built-in support for [Svelte](https://svelte.dev/).
No configuration is needed to enable Svelte support—just start writing Svelte components in `src/components`.

View file

@ -1,5 +1,9 @@
# Using Vue with Astro
```
npm init astro --template framework-vue
```
This example showcases Astro's built-in support for [Vue (`v3.x`)](https://v3.vuejs.org/).
No configuration is needed to enable Vue support—just start writing Vue components in `src/components`.

View file

@ -1,6 +1,21 @@
## 🎨 Portfolio Example
# Astro Starter Kit: Portfolio
```
npm i
npm start
npm init astro --template portfolio
```
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
## 🧞 Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
|:----------------|:--------------------------------------------|
| `npm install` | Installs dependencies |
| `npm run start` | Starts local dev server at `localhost:3000` |
| `npm run build` | Build your production site to `./dist/` |
## 👀 Want to learn more?
Feel free to check [our documentation](https://github.com/snowpackjs/astro) or jump into our [Discord server](https://astro.build/chat).

View file

@ -1,4 +1,8 @@
# Astro with Markdown
# Astro Example: Markdown
```
npm init astro --template with-markdown
```
This example showcases Astro's [built-in Markdown support](../../docs/markdown.md).

View file

@ -1,3 +1,7 @@
# Astro with [`nanostores`](https://github.com/nanostores/nanostores)
# Astro Example: Nanostores
```
npm init astro --template with-nanostores
```
This example showcases using [`nanostores`](https://github.com/nanostores/nanostores) to provide shared state between components from different frameworks.

View file

@ -1,5 +1,9 @@
# Astro with [Tailwind](https://tailwindcss.com)
# Astro with Tailwind
Astro comes with Tailwind support out of the box. This example showcases how to style your Astro project with [Tailwind](https://tailwindcss.com).
```
npm init astro --template with-tailwind
```
For complete setup instructions, please see our [Styling Guide](https://github.com/snowpackjs/astro/blob/main/docs/styling.md#-tailwind).
Astro comes with [Tailwind](https://tailwindcss.com) support out of the box. This example showcases how to style your Astro project with Tailwind.
For complete setup instructions, please see our [Styling Guide](/docs/guides/styling.md#-tailwind).