0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-16 21:46:22 -05:00
astro/examples/non-html-pages
2022-08-31 15:27:36 -04:00
..
.vscode Audit examples templates (#3940) 2022-08-04 14:16:51 -04:00
public Switch examples favicon to use svg (#4331) 2022-08-17 15:19:04 -05:00
src Add Astro.generator (#4012) 2022-08-08 12:34:05 -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 Add Non-HTML Pages example (#2637) 2022-02-25 08:18:48 -08:00
astro.config.mjs Astro Integration System (#2820) 2022-03-18 15:35:45 -07:00
package.json Revert "Update templates to avoid devDependencies and :global (#4544)" (#4575) 2022-08-31 15:27:36 -04:00
README.md update example scripts (#4098) 2022-08-05 21:36:23 -07:00
sandbox.config.json Add Non-HTML Pages example (#2637) 2022-02-25 08:18:48 -08:00
tsconfig.json Add template tsconfigs for users to extend from (#4439) 2022-08-25 15:15:27 -04:00

Astro Starter Kit: Non-HTML Pages

Documentation for "Non-HTML Pages":

https://docs.astro.build/en/core-concepts/astro-pages/#non-html-pages

npm init astro -- --template non-html-pages

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/
│   └── pages/
│       └── index.astro
│       └── about.json.ts
└── 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.