blob: 7d7183a9f94cdd412c292b4a9f442675198d9fe1 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
# Astro Starter Kit: Blog
```
npm init astro -- --template blog
```
[](https://stackblitz.com/github/withastro/astro/tree/latest/examples/blog)
> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
Features:
- ✅ SEO-friendly setup with canonical URLs and OpenGraph data
- ✅ Full Markdown support
## 🚀 Project Structure
Inside of your Astro project, you'll see the following folders and files:
```
├── README.md
├── astro.config.mjs
├── package.json
├── public
│ ├── assets
│ │ └── blog
│ │ └── introducing-astro.jpg
│ ├── favicon.ico
│ ├── social.jpg
│ └── social.png
├── sandbox.config.json
├── src
│ ├── components
│ │ ├── Author.astro
│ │ ├── BaseHead.astro
│ │ ├── BlogHeader.astro
│ │ ├── BlogPost.astro
│ │ ├── BlogPostPreview.astro
│ │ ├── Heading.astro
│ │ └── Logo.astro
│ ├── layouts
│ │ └── BlogPost.astro
│ ├── pages
│ │ ├── index.astro
│ │ └── posts
│ │ └── index.md
│ └── styles
│ └── blog.css
└── tsconfig.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://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
|