astro/examples/blog/README.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

55 lines
1.7 KiB
Markdown
Raw Normal View History

2021-09-06 08:31:10 +00:00
# Astro Starter Kit: Blog
2021-09-06 08:31:10 +00:00
```
npm init astro -- --template blog
```
2021-11-23 22:47:05 +00:00
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/blog)
2021-09-16 15:06:22 +00:00
2021-09-06 08:31:10 +00:00
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
2021-05-17 22:45:41 +00:00
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:
2021-09-06 08:31:10 +00:00
```
/
├── public/
2021-09-06 08:31:10 +00:00
│ ├── robots.txt
│ └── favicon.ico
├── src/
│ ├── components/
2021-09-06 08:31:10 +00:00
│ │ └── Tour.astro
│ └── pages/
│ └── index.astro
└── package.json
```
2021-09-06 08:31:10 +00: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.
2021-09-06 08:31:10 +00:00
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
2021-09-06 08:31:10 +00:00
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://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).