mirror of
https://github.com/withastro/astro.git
synced 2024-12-23 21:53:55 -05:00
73ca0ef383
* [ci] release * Update changelogs (#5955) * [ci] release * Wrap astro 2.0 beta logs in `<details>` * Add link to docs upgrade guide * First pass cleaning up 2.0 release notes * mdx changes from Sarah * combine 5584 and 5842 in deno, image, netlify * markdown/remark incl (5684 & 5769) to match mdx * Tweak markdown/remark formatting * Format astro-prism * Format astro-rss * Format create-astro * Format cloudflare * Format lit * Format partytown * Format node * Format preact * Format react * Format solid * Format svelte * Format tailwind * Format vercel * Format vue * Format telemetry * Format webapi * Format scripts * Reinstate h3s for headings Co-authored-by: Ben Holmes <hey@bholmes.dev> * Reformat mdx * astro & markdown/remark: Combine #5679 & #5684 changelogs Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Chris Swithinbank <swithinbank@gmail.com> Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> Co-authored-by: Ben Holmes <hey@bholmes.dev> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Matthew Phillips <matthew@skypack.dev> Co-authored-by: Chris Swithinbank <swithinbank@gmail.com> Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> Co-authored-by: Ben Holmes <hey@bholmes.dev> |
||
---|---|---|
.. | ||
.vscode | ||
public | ||
src | ||
.gitignore | ||
astro.config.mjs | ||
package.json | ||
README.md | ||
sandbox.config.json | ||
tsconfig.json |
Welcome to Astro
🧑🚀 Seasoned astronaut? Delete this file. Have fun!
🚀 Project Structure
Inside of your Astro project, you'll see the following folders and files:
/
├── public/
│ └── favicon.svg
├── src/
│ ├── components/
│ │ └── Card.astro
│ ├── layouts/
│ │ └── Layout.astro
│ └── 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 preview |
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.