2021-09-06 03:31:10 -05:00
# Astro Starter Kit: Blog
2021-07-01 07:43:25 -05:00
2021-09-06 03:31:10 -05:00
```
npm init astro -- --template blog
```
2021-04-14 11:36:00 -05:00
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)
2021-09-16 10:06:22 -05:00
2021-09-06 03:31:10 -05:00
> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
2021-06-08 10:10:56 -05:00
2021-05-17 17:45:41 -05:00
Features:
2022-08-13 02:09:40 -05:00
- ✅ Minimal styling (make it your own!)
- ✅ 100/100 Lighthouse performance
2022-08-14 23:26:33 -05:00
- ✅ SEO-friendly with canonical URLs and OpenGraph data
- ✅ Sitemap support
- ✅ RSS Feed support
- ✅ Markdown & MDX support
2021-05-17 17:45:41 -05:00
2021-06-08 10:10:56 -05:00
## 🚀 Project Structure
Inside of your Astro project, you'll see the following folders and files:
2021-04-14 11:36:00 -05:00
2021-09-06 03:31:10 -05:00
```
2022-08-13 02:09:40 -05:00
├── public/
├── src/
│ ├── components/
│ ├── layouts/
│ └── pages/
2022-07-12 11:17:36 -05:00
├── astro.config.mjs
├── README.md
├── package.json
2022-06-15 10:32:40 -05:00
└── tsconfig.json
2021-04-14 11:36:00 -05:00
```
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.
2021-04-14 11:36:00 -05:00
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.
2021-04-14 11:36:00 -05:00
2021-09-06 03:31:10 -05:00
Any static assets, like images, can be placed in the `public/` directory.
2021-04-14 11:36:00 -05:00
2021-06-08 10:10:56 -05:00
## 🧞 Commands
2021-04-14 11:36:00 -05:00
2021-06-08 10:10:56 -05:00
All commands are run from the root of the project, from a terminal:
2022-08-05 23:36:23 -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 |
| `npm run astro ...` | Run CLI commands like `astro add` , `astro check` |
| `npm run astro --help` | Get help using the Astro CLI |
2021-06-08 10:10:56 -05:00
## 👀 Want to learn more?
2021-04-14 11:36:00 -05:00
2022-08-13 02:09:40 -05:00
Check out [our documentation ](https://docs.astro.build ) or jump into our [Discord server ](https://astro.build/chat ).
## Credit
This theme is based off of the lovely [Bear Blog ](https://github.com/HermanMartinus/bearblog/ ).