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
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.
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 |
Feel free to check our documentation or jump into our Discord server.