jekyll logo

Want a Jekyll site built?

Hire a Jekyll developer

Welcome to Astro

šŸ§‘ā€šŸš€ Seasoned astronaut? Delete this file. Have fun!

šŸš€ Project Structure

Inside of your Astro project, you'll see the following folders and files:

/
ā”œā”€ā”€ public/
ā”‚   ā””ā”€ā”€ favicon.ico
ā”œā”€ā”€ src/
ā”‚   ā”œā”€ā”€ components/
ā”‚   ā”‚   ā””ā”€ā”€ Layout.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 or layouts.

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

šŸ‘€ Want to learn more?

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

jekyll logo

Want a Jekyll site built?

Hire a Jekyll developer

Get New Themes & Resources