## 1. Project Overview & Quickstart (withastro/astro) ## Install The **recommended** way to install the latest version of Astro is by running the command below: ```bash npm create astro@latest ``` You can also install Astro **manually** by running this command instead: ```bash npm install astro ``` Looking for help? Start with our [Getting Started](https://docs.astro.build/en/getting-started/) guide. Looking for quick examples? [Open a starter project](https://astro.new/) right in your browser. ## Documentation Visit our [official documentation](https://docs.astro.build/). ## Support Having trouble? Get help in the official [Astro Discord](https://astro.build/chat). ## Contributing **New contributors welcome!** Check out our [Contributors Guide](CONTRIBUTING.md) for help getting started. Join us on [Discord](https://astro.build/chat) to meet other maintainers. We'll help you get your first contribution in no time! ## Directory | Package | Release Notes | | ------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [astro](packages/astro) | [](packages/astro/CHANGELOG.md) | | [create-astro](packages/create-astro) | [](packages/create-astro/CHANGELOG.md) | | [@astrojs/react](packages/integrations/react) | [](packages/integrations/react/CHANGELOG.md) | | [@astrojs/preact](packages/integrations/preact) | [](packages/integrations/preact/CHANGELOG.md) | | [@astrojs/solid-js](packages/integrations/solid) | [](packages/integrations/solid/CHANGELOG.md) | | [@astrojs/svelte](packages/integrations/svelte) | [](packages/integrations/svelte/CHANGELOG.md) | | [@astrojs/vue](packages/integrations/vue) | [](packages/integrations/vue/CHANGELOG.md) | | [@astrojs/node](packages/integrations/node) | [](packages/integrations/node/CHANGELOG.md) | | [@astrojs/vercel](packages/integrations/vercel) | [](packages/integrations/vercel/CHANGELOG.md) | | [@astrojs/cloudflare](packages/integrations/cloudflare) | [](packages/integrations/cloudflare/CHANGELOG.md) | | [@astrojs/partytown](packages/integrations/partytown) | [](packages/integrations/partytown/CHANGELOG.md) | | [@astrojs/sitemap](packages/integrations/sitemap) | [](packages/integrations/sitemap/CHANGELOG.md) | | [@astrojs/alpinejs](packages/integrations/alpinejs) | [](packages/integrations/alpinejs/CHANGELOG.md) | | [@astrojs/mdx](packages/integrations/mdx) | [](packages/integrations/mdx/CHANGELOG.md) | | [@astrojs/rss](packages/astro-rss) | [](packages/astro-rss/CHANGELOG.md) | | [@astrojs/netlify](packages/integrations/netlify) | [](packages/integrations/netlify/CHANGELOG.md) | | [@astrojs/check](packages/language-tools/astro-check) | [](packages/language-tools/astro-check/CHANGELOG.md) | | [@astrojs/language-server](packages/language-tools/language-server) | [](packages/language-tools/language-server/CHANGELOG.md) | | [@astrojs/ts-plugin](packages/language-tools/ts-plugin) | [](packages/language-tools/ts-plugin/CHANGELOG.md) | | [astro-vscode](packages/language-tools/vscode) | [](packages/language-tools/vscode/CHANGELOG.md) | [](https://bestpractices.coreinfrastructure.org/projects/6178) Several official projects are maintained outside of this repo: | Project | Repository | | ---------------------------------------------------------- | ------------------------------------------------------------- | | [@astrojs/compiler](https://github.com/withastro/compiler) | [withastro/compiler](https://github.com/withastro/compiler) | | [Starlight](https://github.com/withastro/starlight) | [withastro/starlight](https://github.com/withastro/starlight) | ## Links - [License (MIT)](LICENSE) - [Code of Conduct](https://github.com/withastro/.github/blob/main/CODE_OF_CONDUCT.md) - [Open Governance & Voting](https://github.com/withastro/.github/blob/main/GOVERNANCE.md) - [Project Funding](https://github.com/withastro/.github/blob/main/FUNDING.md) - [Website](https://astro.build/) ## Sponsors Astro is free, open source software made possible by these wonderful sponsors. [❤️ Sponsor Astro! ❤️](https://github.com/withastro/.github/blob/main/FUNDING.md) ## 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](https://docs.astro.build/). This repo contains all the source code we use to build our docs site. [](https://codesandbox.io/p/github/withastro/docs) [](https://pr.new/github.com/withastro/docs) ## 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](https://astro.build/chat). ## 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](https://github.com/withastro/docs/issues), and if not, [create a new one](https://github.com/withastro/docs/issues/new/choose). ## 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](https://github.com/withastro/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](https://github.com/withastro/docs/blob/main/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](https://contribute.docs.astro.build/guides/i18n/) for more details. ### Translation progress ## Next Steps - [Read the docs](https://docs.astro.build/) - [Raise an issue](https://github.com/withastro/docs/issues/new) - [Participate in a discussion](https://github.com/withastro/docs/discussions) - [Join the #docs channel on Discord](https://discord.gg/cZDZU3hJHc)