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
Houston (Bot) 6afb1efea8
[ci] release (#6541)
* [ci] release

* nit: typo in #6594 changeset

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Ben Holmes <hey@bholmes.dev>
2023-03-21 08:03:46 -04:00
..
.vscode
public chore: update example favicons (#6487) 2023-03-09 11:23:47 -06:00
src
.gitignore Add .astro/ to .gitignore in example projects (#5841) 2023-01-12 11:26:13 -05:00
astro.config.mjs
package.json [ci] release (#6541) 2023-03-21 08:03:46 -04:00
README.md Update doc link in non-html-pages example README (#6369) 2023-02-25 19:54:36 +01:00
sandbox.config.json
tsconfig.json

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: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.