mirror of
https://github.com/withastro/astro.git
synced 2024-12-23 21:53:55 -05:00
fca1a99dbd
* Support for using a subpath * Update the readme * Fix the package name * Adds a changeset * Ensure that public/ must be loaded from the subpath * Update preview to use the new paths * Use exact compiler version * Use the newest version * Use range again * Use newer range
45 lines
1.6 KiB
Markdown
45 lines
1.6 KiB
Markdown
# Astro Starter Kit: A site deployed to a subpath
|
|
|
|
```
|
|
npm init astro -- --template subpath
|
|
```
|
|
|
|
[](https://stackblitz.com/github/snowpackjs/astro/tree/latest/examples/subpath)
|
|
|
|
> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
|
|
|
|
## 🚀 Project Structure
|
|
|
|
Inside of your Astro project, you'll see the following folders and files:
|
|
|
|
```
|
|
/
|
|
├── public/
|
|
├── src/
|
|
│ └── components/
|
|
│ └── Time.jsx
|
|
│ └── 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 |
|
|
|
|
## 👀 Want to learn more?
|
|
|
|
Feel free to check [our documentation](https://github.com/snowpackjs/astro) or jump into our [Discord server](https://astro.build/chat).
|