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

History

Fred K. Schott 9f06fb014b cleanup docs changes		2021-09-06 01:31:10 -07:00
..
public	[ci] yarn format	2021-08-25 18:52:22 +00:00
src	add dev script, switch documentation from advising start to dev script (#1141 )	2021-08-18 22:07:08 -07:00
.gitignore	redesign create-astro (#301 )	2021-06-08 11:10:56 -04:00
.npmrc	force pnpm to hoist packages inside astro #342 #190 (#530 )	2021-06-24 09:48:25 -04:00
astro.config.mjs	Add zod schema validation (#1198 )	2021-08-23 14:07:03 -07:00
package.json	cleanup docs changes	2021-09-06 01:31:10 -07:00
README.md	cleanup docs changes	2021-09-06 01:31:10 -07:00
tsconfig.json	[ci] yarn format	2021-08-13 23:32:55 +00: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
✅ 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/`

👀 Want to learn more?

Feel free to check our documentation or jump into our Discord server.