mirror of https://github.com/withastro/astro.git synced 2024-12-23 21:53:55 -05:00

History

Fred K. Bot 056d4d5fd2 [ci] release (#3903 ) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>		2022-07-13 17:16:24 -04:00
..
.vscode	[ci] format	2022-03-22 03:16:42 +00:00
public	Example blog rework (#3896 )	2022-07-12 12:17:36 -04:00
src	[ci] format	2022-07-12 16:20:08 +00:00
.gitignore	refactor(vercel): Build Output API v3 (#3216 )	2022-05-11 15:10:38 -06:00
.npmrc	Move from yarn to pnpm (#2455 )	2022-03-08 15:46:11 -06:00
.stackblitzrc	update examples for stackblitz (#1379 )	2021-09-16 08:06:22 -07:00
astro.config.mjs	[ci] format	2022-07-12 16:20:08 +00:00
package.json	[ci] release (#3903 )	2022-07-13 17:16:24 -04:00
README.md	Example blog rework (#3896 )	2022-07-12 12:17:36 -04:00
sandbox.config.json	Adding CodeSandbox config file to all the "next" examples (#1744 )	2021-11-05 10:41:37 -05:00
tsconfig.json	Move client types into Astro (#3851 )	2022-07-11 08:12:18 -04:00

README.md

Astro Starter Kit: Blog

npm init astro -- --template 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:

├── public
│   ├── assets
│   │   └── blog
│   │       └── introducing-astro.jpg
│   ├── favicon.ico
│   ├── social.jpg
│   └── social.png
├── src
│   ├── components
│   │   ├── Author.astro
│   │   ├── BaseHead.astro
│   │   ├── BlogPostPreview.astro
│   │   ├── FollowMe.astro
│   │   ├── Header.astro
│   │   └── LikeButton.tsx
│   ├── layouts
│   │   └── BlogPost.astro
│   ├── pages
│   │   ├── index.astro
│   │   └── posts
│   │       ├── interactive-content.md
│   │       └── static-content.md
│   └── styles
│       └── blog.css
├── astro.config.mjs
├── README.md
├── package.json
└── 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 or jump into our Discord server.