mirror of
https://github.com/withastro/astro.git
synced 2024-12-16 21:46:22 -05:00
84275e0810
* Add `SECURITY.md` and `SECURITY_CONTACTS` Signed by: Randall T. Vasquez <ran.dall@icloud.com> * Add OpenSFF Best Practices badge Signed by: Randall T. Vasquez <ran.dall@icloud.com> Co-authored-by: Matthew Phillips <matthew@skypack.dev> Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>
128 lines
8.4 KiB
Markdown
128 lines
8.4 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
|
||
|
||
|
||
```bash
|
||
# Recommended!
|
||
npm create astro@latest
|
||
|
||
# Manual:
|
||
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 [offical 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/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) |
|
||
|
||
[](https://bestpractices.coreinfrastructure.org/projects/6178)
|
||
|
||
Several official projects are maintained outside of this repo:
|
||
|
||
| Project | Repository |
|
||
| ------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
||
| [@astrojs/compiler](packages/integrations/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, Vercel, and several other amazing organizations.
|
||
|
||
[❤️ Sponsor Astro! ❤️](https://github.com/withastro/.github/blob/main/FUNDING.md)
|
||
|
||
### Platinum Sponsors
|
||
|
||
<table>
|
||
<tbody>
|
||
<tr>
|
||
<td align="center"><a href="https://www.netlify.com/#gh-light-mode-only" target="_blank"><img width="147" height="40" src="https://raw.githubusercontent.com/withastro/astro/main/.github/assets/netlify.svg#gh-light-mode-only" alt="Netlify" /></a><a href="https://www.netlify.com/#gh-dark-mode-only" target="_blank"><img width="147" height="40" src="https://raw.githubusercontent.com/withastro/astro/main/.github/assets/netlify-dark.svg#gh-dark-mode-only" alt="Netlify" />
|
||
</a></td>
|
||
<td align="center"><a href="https://www.vercel.com/#gh-light-mode-only" target="_blank"><img width="150" height="34" src="https://raw.githubusercontent.com/withastro/astro/main/.github/assets/vercel.svg#gh-light-mode-only" alt="Vercel" /></a><a href="https://www.vercel.com/#gh-dark-mode-only"><img width="150" height="34" src="https://raw.githubusercontent.com/withastro/astro/main/.github/assets/vercel-dark.svg#gh-dark-mode-only" alt="Vercel" />
|
||
</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
### Gold Sponsors
|
||
|
||
<table>
|
||
<tbody>
|
||
<tr>
|
||
<td align="center">
|
||
<a href="https://divRIOTS.com#gh-light-mode-only" target="_blank">
|
||
<img width="150" height="40" src="https://raw.githubusercontent.com/withastro/astro/main/.github/assets/divriots.svg#gh-light-mode-only" alt="‹div›RIOTS" />
|
||
</a>
|
||
<a href="https://divRIOTS.com#gh-dark-mode-only" target="_blank">
|
||
<img width="150" height="40" src="https://raw.githubusercontent.com/withastro/astro/main/.github/assets/divriots-dark.svg#gh-dark-mode-only" alt="‹div›RIOTS" />
|
||
</a>
|
||
</td>
|
||
<td align="center">
|
||
<a href="https://stackupdigital.co.uk/#gh-light-mode-only" target="_blank">
|
||
<img width="162" height="40" src="https://raw.githubusercontent.com/withastro/astro/main/.github/assets/stackup.svg#gh-light-mode-only" alt="StackUp Digital" />
|
||
</a>
|
||
<a href="https://stackupdigital.co.uk/#gh-dark-mode-only" target="_blank">
|
||
<img width="130" height="32" src="https://raw.githubusercontent.com/withastro/astro/main/.github/assets/stackup-dark.svg#gh-dark-mode-only" alt="StackUp Digital" />
|
||
</a>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
### Sponsors
|
||
|
||
<table>
|
||
<tbody>
|
||
<tr>
|
||
<td align="center"><a href="https://sentry.io" target="_blank"><img width="147" height="40" src="https://raw.githubusercontent.com/withastro/astro/main/.github/assets/sentry.svg" alt="Sentry" /></a></td><td align="center"><a href="https://qoddi.com" target="_blank"><img width="147" height="40" src="https://devcenter.qoddi.com/wp-content/uploads/2021/11/blog-transparent-logo-1.png" alt="Qoddi App Platform" /></a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|