Astro GitHub Pages Template

🤖 Automatic Deployment to GitHub Pages

This minimal Astro project template comes with a GitHub Action that automatically deploys your site to GitHub Pages.

For more information, please see our complete deployment guide—Deploy your Astro Site to GitHub Pages.

🚀 Project Structure

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

/
├── public/
│   └── favicon.ico
├── 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 or layouts.

Any static assets, like images, can be placed in the public/ directory.

👀 Want to learn more?

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