1. Project Overview & Quickstart (withastro/astro)
Install
The recommended way to install the latest version of Astro is by running the command below:
npm create astro@latestYou can also install Astro manually by running this command instead:
npm install astroLooking 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.
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
Several official projects are maintained outside of this repo:
| Project | Repository |
|---|---|
| @astrojs/compiler | withastro/compiler |
| Starlight | withastro/starlight |
Links
Sponsors
Astro is free, open source software made possible by these wonderful sponsors.
2. Official Technical Reference & Guides (withastro/astro-docs)
Astro Docs
To all who come to this happy place: welcome.
This is the repo for docs.astro.build.
This repo contains all the source code we use to build our docs site.
We are Astro
Astro is an all-in-one web framework for building fast, content-focused websites.
We want everyone to be successful building sites, and that means helping everyone understand how Astro works.
You are Awesome
You can also help make the docs awesome.
Your feedback is welcome.
Your writing, editing, translating, designing, and developing skills are welcome.
You being a part of our community is welcome.
Chat with Us
You can learn more about Astro, get support, and meet other devs in our Discord community.
Raise an Issue
Is something missing?
Is something confusing?
Is something wrong?
Creating a new Issue puts a problem on our radar!
See if your issue has already been reported, and if not, create a new one.
Share an Idea
Could something be better?
Want to share an idea with us?
Discussions are threads where you can offer feedback on things that might not exactly be problems to be fixed but are ideas to be explored.
Join the Docs Discussions where we brainstorm, ask questions, share hopes and dreams...
Make a Fix or Contribution
Did you find a typo, a broken link, or another item with an obvious quick fix?
If you can see what the problem is, and you know how to fix it, then you can make a PR (pull request) with the change and contribute to the docs repo yourself.
Want to make a larger contribution? Please see CONTRIBUTING.md first!
Translate a Page
Speak another language natively?
Join our i18n gang on Discord or jump into the PRs to help with reviewing existing draft translations!
Check out the dedicated i18n guide for more details.