astro/examples/non-html-pages/README.md
Emanuele Stoppa 1b7dd11823
feat: change default port to 4321 (#7874)
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
2023-08-01 16:31:42 +01:00

2.2 KiB

Astro Starter Kit: Non-HTML Pages

Documentation for "Non-HTML Pages":

https://docs.astro.build/en/core-concepts/endpoints/#static-file-endpoints

npm create astro@latest -- --template non-html-pages

Open in StackBlitz Open with CodeSandbox Open in GitHub Codespaces

🧑‍🚀 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, .js or .ts 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:4321
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.