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
- β
@astrojs/image
image optimizations - β Sitemap support
- β Markdown & MDX support
- β Minimal styling (make it your own!)
- β 100/100 Lighthouse performance
π Project Structure
Inside of your Astro project, you'll see the following folders and files:
βββ public/
βββ src/
β βββ components/
β βββ layouts/
β βββ pages/
βββ 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 |
npm run astro ... |
Run CLI commands like astro add , astro check |
npm run astro --help |
Get help using the Astro CLI |
π Want to learn more?
Check out our documentation or jump into our Discord server.
Credit
This theme is based off of the lovely Bear Blog.