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:
βββ 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.
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.