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
Obinna Ekwuno 8cdd5aabdb
Add “Open with CodeSandbox” buttons to example project READMEs (#5322)
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
2022-11-10 11:32:13 +01: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 Run astro check on all examples in CI (#5022) 2022-10-12 09:48:29 -03:00
.gitignore refactor(vercel): Build Output API v3 (#3216) 2022-05-11 15:10:38 -06:00
astro.config.mjs Astro Integration System (#2820) 2022-03-18 15:35:45 -07:00
package.json [ci] release (#5325) 2022-11-08 13:00:53 -05:00
README.md Add “Open with CodeSandbox” buttons to example project READMEs (#5322) 2022-11-10 11:32:13 +01: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 create astro@latest -- --template non-html-pages

Open in StackBlitz Open with CodeSandbox

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