94 lines
6.9 KiB
Markdown
94 lines
6.9 KiB
Markdown
<p align="center">
|
|
<img src="assets/social/banner-minimal.png" alt="Astro logo">
|
|
<br/><br/>
|
|
<a href="https://astro.build">Astro</a> is a website build tool for the modern web —
|
|
<br/>
|
|
powerful developer experience meets lightweight output.
|
|
<br/><br/>
|
|
</p>
|
|
|
|
## 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 --save-dev 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-js/CHANGELOG.md) |
|
|
| [@astrojs/svelte](packages/integrations/svelte) | [](packages/integrations/svelte/CHANGELOG.md) |
|
|
| [@astrojs/vue](packages/integrations/vue) | [](packages/integrations/vue/CHANGELOG.md) |
|
|
| [@astrojs/lit](packages/integrations/lit) | [](packages/integrations/lit/CHANGELOG.md) |
|
|
| [@astrojs/deno](packages/integrations/deno) | [](packages/integrations/deno/CHANGELOG.md) |
|
|
| [@astrojs/netlify](packages/integrations/netlify) | [](packages/integrations/netlify/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/tailwind](packages/integrations/tailwind) | [](packages/integrations/tailwind/CHANGELOG.md) |
|
|
| [@astrojs/turbolinks](packages/integrations/turbolinks) | [](packages/integrations/turbolinks/CHANGELOG.md) |
|
|
| [@astrojs/alpinejs](packages/integrations/alpinejs) | [](packages/integrations/alpinejs/CHANGELOG.md) |
|
|
| [@astrojs/image](packages/integrations/image) | [](packages/integrations/image/CHANGELOG.md) |
|
|
| [@astrojs/mdx](packages/integrations/mdx) | [](packages/integrations/mdx/CHANGELOG.md) |
|
|
| [@astrojs/prefetch](packages/integrations/prefetch) | [](packages/integrations/prefetch/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) |
|
|
| [Astro Language Tools](https://github.com/withastro/language-tools) | [withastro/language-tools](https://github.com/withastro/language-tools) |
|
|
|
|
|
|
## 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 generously supported by Netlify, Storyblok, and several other amazing organizations.
|
|
|
|
[❤️ Sponsor Astro! ❤️](https://github.com/withastro/.github/blob/main/FUNDING.md)
|
|
|
|
<p align="center">
|
|
<a target="_blank" href="https://github.com/sponsors/withastro">
|
|
<img alt="sponsors" src="https://astro.build/sponsors.png">
|
|
</a>
|
|
</p>
|