astro README

The project's README from github.com/withastro/astro. As one markdown file: README.md.

Build the web you want


Astro is a website build tool for the modern web —
powerful developer experience meets lightweight output.

main License npm version

Install

The recommended way to install the latest version of Astro is by running the command below:

npm create astro@latest

You can also install Astro manually by running this command instead:

npm install astro

Looking for help? Start with our Getting Started guide.

Looking for quick examples? Open a starter project right in your browser.

Documentation

Visit our official documentation.

Support

Having trouble? Get help in the official Astro Discord or via GitHub discussions.

Contributing

New contributors welcome! Check out our Contributors Guide for help getting started.

Join us on Discord to meet other maintainers. We'll help you get your first contribution in no time!

Directory

Package Release Notes
astro astro version
create-astro create-astro version
@astrojs/react @astrojs/react version
@astrojs/preact @astrojs/preact version
@astrojs/solid-js @astrojs/solid version
@astrojs/svelte @astrojs/svelte version
@astrojs/vue @astrojs/vue version
@astrojs/node @astrojs/node version
@astrojs/vercel @astrojs/vercel version
@astrojs/cloudflare @astrojs/cloudflare version
@astrojs/partytown @astrojs/partytown version
@astrojs/sitemap @astrojs/sitemap version
@astrojs/alpinejs @astrojs/alpinejs version
@astrojs/mdx @astrojs/mdx version
@astrojs/rss @astrojs/rss version
@astrojs/netlify @astrojs/netlify version
@astrojs/check astro-check version
@astrojs/language-server @astrojs/language-server version
@astrojs/ts-plugin @astrojs/ts-plugin version
astro-vscode astro-vscode version

CII Best Practices

Several official projects are maintained outside of this repo:

Project Repository
@astrojs/compiler withastro/compiler
Starlight withastro/starlight

Sponsors

Astro is free, open source software made possible by these wonderful sponsors.

❤️ Sponsor Astro! ❤️

Sponsor logos including the current Astro Sponsors, Gold Sponsors, and Exclusive Partner Sponsors: Netlify, Sentry, and Project IDX.

astro (withastro/astro)

Searching Database…

63.3K ·GitHub
What is this?Astro is a free, open source web framework for building content-driven websites — blogs and other content-heavy sites — with a powerful developer experience and a lightweight output.
Is it an app I run, or something I build websites with?You build with it: Astro ships as a set of npm packages — the astro core, a create-astro project scaffolder and official integrations — not as a ready-made application.
How do I start a new site with it?Scaffold a new project with create-astro (the README's recommended install path), or add Astro manually to an existing project, then follow the Getting Started guide.
What do I need installed before I can use it?Node.js: the repo's engines pin Node 22.12.0 or newer. The monorepo itself builds with pnpm and Turbo, but that only matters if you work on Astro's source code.
Does it matter which operating system I'm on?Not really — Astro runs as a Node.js command-line tool on Windows, macOS and Linux, and what it produces are plain websites that any web host can serve.
Which UI frameworks can I pair with it?Official integrations cover React, Preact, Svelte, Solid, Vue and Alpine.js, plus add-ons for MDX content, RSS feeds and sitemaps.
Where can I deploy the finished site?Official adapters target Node, Vercel, Cloudflare and Netlify, so one project can ship as a static site or as a server-rendered app.
Can I try it before installing anything?Yes — the README links quick examples you can open as a starter project right in your browser, no local setup required.
Creator
withastro
Size
234.7 MB
Stars
63.3K
Age
5y
Commits · 90 Days