https://github.com/alan-fgr/lto

https://github.com/alan-fgr/lto

Last synced: 24 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/alan-fgr/lto
• Owner: Alan-FGR
• License: mit
• Created: 2024-02-27T21:18:07.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-08-02T20:55:41.000Z (3 months ago)
• Last Synced: 2024-08-02T23:31:51.439Z (3 months ago)
• Language: Astro
• Size: 12.3 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.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).