withastro/github-pages

Automatically deploy an Astro site to GitHub Pages

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/
├── 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.

🧞 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?

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

github-pages's Issues

Tailwind CSS not work on GitHub Pages

Hello!

I am styling astro page with Tailwind CSS. But for some reason, the tailwind classes do not appear on the deployed GitHub page although it does show during the local build environment.

I have installed Tailwind through npm install @astrojs/tailwind and follow the official documentation as described on https://docs.astro.build/en/guides/integrations-guide/tailwind/

How to make Tailwind CSS work after deploy on GitHub Pages?

My test project is this one: https://github.com/molystechie/Astro-hello-world