mirror of
https://github.com/withastro/astro.git
synced 2024-12-23 21:53:55 -05:00
97 lines
7.7 KiB
Markdown
97 lines
7.7 KiB
Markdown
![Build the web you want](.github/assets/banner.png 'Build the web you want')
|
||
|
||
<p align="center">
|
||
<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) | [![astro version](https://img.shields.io/npm/v/astro.svg?label=%20)](packages/astro/CHANGELOG.md) |
|
||
| [create-astro](packages/create-astro) | [![create-astro version](https://img.shields.io/npm/v/create-astro.svg?label=%20)](packages/create-astro/CHANGELOG.md) |
|
||
| [@astrojs/react](packages/integrations/react) | [![astro version](https://img.shields.io/npm/v/@astrojs/react.svg?label=%20)](packages/integrations/react/CHANGELOG.md) |
|
||
| [@astrojs/preact](packages/integrations/preact) | [![astro version](https://img.shields.io/npm/v/@astrojs/preact.svg?label=%20)](packages/integrations/preact/CHANGELOG.md) |
|
||
| [@astrojs/solid-js](packages/integrations/solid) | [![astro version](https://img.shields.io/npm/v/@astrojs/solid-js.svg?label=%20)](packages/integrations/solid/CHANGELOG.md) |
|
||
| [@astrojs/svelte](packages/integrations/svelte) | [![astro version](https://img.shields.io/npm/v/@astrojs/svelte.svg?label=%20)](packages/integrations/svelte/CHANGELOG.md) |
|
||
| [@astrojs/vue](packages/integrations/vue) | [![astro version](https://img.shields.io/npm/v/@astrojs/vue.svg?label=%20)](packages/integrations/vue/CHANGELOG.md) |
|
||
| [@astrojs/lit](packages/integrations/lit) | [![astro version](https://img.shields.io/npm/v/@astrojs/lit.svg?label=%20)](packages/integrations/lit/CHANGELOG.md) |
|
||
| [@astrojs/node](packages/integrations/node) | [![astro version](https://img.shields.io/npm/v/@astrojs/node.svg?label=%20)](packages/integrations/node/CHANGELOG.md) |
|
||
| [@astrojs/vercel](packages/integrations/vercel) | [![astro version](https://img.shields.io/npm/v/@astrojs/vercel.svg?label=%20)](packages/integrations/vercel/CHANGELOG.md) |
|
||
| [@astrojs/cloudflare](https://github.com/withastro/adapters/blob/main/packages/cloudflare) | [![astro version](https://img.shields.io/npm/v/@astrojs/cloudflare.svg?label=%20)](https://github.com/withastro/adapters/blob/main/packages/cloudflare/CHANGELOG.md) |
|
||
| [@astrojs/partytown](packages/integrations/partytown) | [![astro version](https://img.shields.io/npm/v/@astrojs/partytown.svg?label=%20)](packages/integrations/partytown/CHANGELOG.md) |
|
||
| [@astrojs/sitemap](packages/integrations/sitemap) | [![astro version](https://img.shields.io/npm/v/@astrojs/sitemap.svg?label=%20)](packages/integrations/sitemap/CHANGELOG.md) |
|
||
| [@astrojs/tailwind](packages/integrations/tailwind) | [![astro version](https://img.shields.io/npm/v/@astrojs/tailwind.svg?label=%20)](packages/integrations/tailwind/CHANGELOG.md) |
|
||
| [@astrojs/alpinejs](packages/integrations/alpinejs) | [![astro version](https://img.shields.io/npm/v/@astrojs/alpinejs.svg?label=%20)](packages/integrations/alpinejs/CHANGELOG.md) |
|
||
| [@astrojs/mdx](packages/integrations/mdx) | [![astro version](https://img.shields.io/npm/v/@astrojs/mdx.svg?label=%20)](packages/integrations/mdx/CHANGELOG.md) |
|
||
| [@astrojs/prefetch](packages/integrations/prefetch) | [![astro version](https://img.shields.io/npm/v/@astrojs/prefetch.svg?label=%20)](packages/integrations/prefetch/CHANGELOG.md) |
|
||
|
||
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/6178/badge)](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 free, open source software made possible by these wonderful sponsors.
|
||
|
||
[❤️ Sponsor Astro! ❤️](https://github.com/withastro/.github/blob/main/FUNDING.md)
|
||
|
||
<p align="center">
|
||
<a target="_blank" href="https://github.com/sponsors/withastro">
|
||
|
||
[![Astro's sponsors.](https://astro.build/sponsors.png "Astro's sponsors.
|
||
Platinum sponsors: Vercel, storyblok, Netlify, Ship Shape, Google Chrome
|
||
Gold sponsors: ‹div›RIOTS, DEEPGRAM, Transloadit, CloudCannon
|
||
Sponsors: Monogram, Qoddi, Dimension")](https://github.com/sponsors/withastro)
|
||
|
||
</a>
|
||
</p>
|