astro/examples/blog-multiple-authors/README.md

# Astro Starter Kit: Blog with Multiple Authors

```
npm init astro -- --template blog-multiple-authors
```

[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/blog-multiple-authors)

> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!

Features:

- ✅ SEO-friendly setup with canonical URLs and OpenGraph data
- ✅ Full Markdown support
- ✅ RSS 2.0 generation
- ✅ Sitemap.xml generation

## 🚀 Project Structure

Inside of your Astro project, you'll see the following folders and files:

```
/
├── public/
│   ├── robots.txt
│   └── favicon.ico
├── src/
│   ├── components/
│   │   └── Tour.astro
│   └── pages/
│       └── index.astro
└── package.json
```

Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.

There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.

Any static assets, like images, can be placed in the `public/` directory.

## 🧞 Commands

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 |

## 👀 Want to learn more?

Feel free to check [our documentation](https://github.com/withastro/astro) or jump into our [Discord server](https://astro.build/chat).
update example readmes (#591) * update example readmes * Update README.md 2021-07-01 07:43:25 -05:00			`# Astro Starter Kit: Blog with Multiple Authors`

cleanup docs changes 2021-09-06 03:31:10 -05:00			```
			`npm init astro -- --template blog-multiple-authors`
			```
update the blog example (#565) 2021-06-28 17:29:16 -05:00
update repo URL (#1994) 2021-11-23 17:47:05 -05:00			`[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/blog-multiple-authors)`
update examples for stackblitz (#1379) 2021-09-16 10:06:22 -05:00
update the blog example (#565) 2021-06-28 17:29:16 -05:00			`> 🧑‍🚀 Seasoned astronaut? Delete this file. Have fun!`

			`Features:`

			`- ✅ SEO-friendly setup with canonical URLs and OpenGraph data`
			`- ✅ Full Markdown support`
			`- ✅ RSS 2.0 generation`
			`- ✅ Sitemap.xml generation`

			`## 🚀 Project Structure`

			`Inside of your Astro project, you'll see the following folders and files:`

			```
cleanup docs changes 2021-09-06 03:31:10 -05:00			`/`
update the blog example (#565) 2021-06-28 17:29:16 -05:00			`├── public/`
cleanup docs changes 2021-09-06 03:31:10 -05:00			`│ ├── robots.txt`
update the blog example (#565) 2021-06-28 17:29:16 -05:00			`│ └── favicon.ico`
			`├── src/`
			`│ ├── components/`
cleanup docs changes 2021-09-06 03:31:10 -05:00			`│ │ └── Tour.astro`
update the blog example (#565) 2021-06-28 17:29:16 -05:00			`│ └── pages/`
			`│ └── index.astro`
			`└── package.json`
			```

cleanup docs changes 2021-09-06 03:31:10 -05:00			Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
update the blog example (#565) 2021-06-28 17:29:16 -05:00
cleanup docs changes 2021-09-06 03:31:10 -05:00			There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
update the blog example (#565) 2021-06-28 17:29:16 -05:00
cleanup docs changes 2021-09-06 03:31:10 -05:00			Any static assets, like images, can be placed in the `public/` directory.
update the blog example (#565) 2021-06-28 17:29:16 -05:00
			`## 🧞 Commands`

			`All commands are run from the root of the project, from a terminal:`

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 14:28:51 -05:00			`\| 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 \|
update the blog example (#565) 2021-06-28 17:29:16 -05:00
			`## 👀 Want to learn more?`

update repo URL (#1994) 2021-11-23 17:47:05 -05:00			`Feel free to check [our documentation](https://github.com/withastro/astro) or jump into our [Discord server](https://astro.build/chat).`