npm create astro@latest -- --template minimal
๐งโ๐ Seasoned astronaut? Delete this file. Have fun!
Inside of your Astro project, you'll see the following folders and files:
/
โโโ public/
โโโ src/
โ โโโ 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.
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:4321 |
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 |
Feel free to check our documentation or jump into our Discord server.
- Add
CC_WEBROOT="/dist"
to serve your static bundle
- File-based routing in Astro
- Astro page HTML
- Dynamic expressions in Astro
- CSS variables in Astro
- Astro Component Overview
- Component Props in Astro
- Component-based Design
- Astro
<slot />
- Astro layout components
Astro.glob()
API documentation
If you need information to construct the page routes, write it inside getStaticPaths()
.
To receive information in the HTML template of a page route, write it outside getStaticPaths()
.
โ Build basic blog with and Astro island and custom components.
โฉ๏ธ Extend with View transitions to control what happens when visitors navigate between pages. tutorial