Skip to content

Latest commit

 

History

History
75 lines (50 loc) · 2.91 KB

README.md

File metadata and controls

75 lines (50 loc) · 2.91 KB

Astro Archipelago pit

This is a hello world pit to the Astro framework. It is a demo of every-day features of Astro.

picture

Pages

  • Home: pages/index.astro

    Fully styled Home landing page. It has navigation to other pages. A dynamic island component Greeting.tsx (made with Preact framework) is also displayed on top.

  • Main Isle

    Empty page to test navigation

  • Githubo Isle

    Handling Mark-down contents in Astro. It contains an index page, a tag list page and tag detail page for the posts. Some posts are also stored in the posts folder.

Astro CLI Readmes

init template

npm create astro@latest -- --template basics

Open in StackBlitz Open with CodeSandbox Open in GitHub Codespaces

🧑‍🚀 Seasoned astronaut? Delete this file. Have fun!

just-the-basics

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