https://github.com/withastro/github-pages

Automatically deploy an Astro site to GitHub Pages
https://github.com/withastro/github-pages

action astro deploy github-pages

Last synced: 4 months ago
JSON representation

Automatically deploy an Astro site to GitHub Pages

• Host: GitHub
• URL: https://github.com/withastro/github-pages
• Owner: withastro
• Created: 2022-08-07T21:42:47.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-11T14:10:12.000Z (over 1 year ago)
• Last Synced: 2024-09-30T17:05:14.271Z (4 months ago)
• Topics: action, astro, deploy, github-pages
• Language: Astro
• Homepage:
• Size: 124 KB
• Stars: 37
• Watchers: 4
• Forks: 13
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# [Astro](https://astro.build) GitHub Pages Template

## 🤖 Automatic Deployment to GitHub Pages

This minimal Astro project template comes with a [GitHub Action](https://github.com/features/actions) that automatically deploys your site to [GitHub Pages](https://pages.github.com/).

For more information, please see our complete deployment guide—[Deploy your Astro Site to GitHub Pages](https://docs.astro.build/en/guides/deploy/github/).

## 🚀 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](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).