astro/examples/subpath
Erika 77ce6be30c
Add template tsconfigs for users to extend from (#4439)
* Add tsconfig templates to extend from

* Add changeset

* Right order for assign parameters

* Add tsconfigs to export map
2022-08-25 15:15:27 -04:00
..
public Switch examples favicon to use svg (#4331) 2022-08-17 15:19:04 -05:00
src Switch examples favicon to use svg (#4331) 2022-08-17 15:19:04 -05:00
.gitignore refactor(vercel): Build Output API v3 (#3216) 2022-05-11 15:10:38 -06:00
.npmrc Move from yarn to pnpm (#2455) 2022-03-08 15:46:11 -06:00
.stackblitzrc Normalize and cleanup examples projects (#2364) 2022-01-12 10:37:16 -05:00
astro.config.mjs chore: updated examples to v0.26.0 (#2977) 2022-04-03 14:02:57 -05:00
package.json [ci] release (#4453) 2022-08-25 12:00:17 -04:00
README.md update example scripts (#4098) 2022-08-05 21:36:23 -07:00
sandbox.config.json Support for using a subpath (#1801) 2021-11-15 10:33:51 -05:00
tsconfig.json Add template tsconfigs for users to extend from (#4439) 2022-08-25 15:15:27 -04:00

Astro Starter Kit: A site deployed to a subpath

npm init astro -- --template subpath

Open in StackBlitz

🧑‍🚀 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
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.