diff --git a/README.md b/README.md deleted file mode 120000 index 6007e27af9b9..000000000000 --- a/README.md +++ /dev/null @@ -1 +0,0 @@ -packages/astro/README.md \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 000000000000..ece0fd865182 --- /dev/null +++ b/README.md @@ -0,0 +1,127 @@ +
+

+ Astro logo + Astro logo +

+ Astro is a website build tool for the modern web — +
+ powerful developer experience meets lightweight output. +

+

+ +## 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) | [![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-js) | [![astro version](https://img.shields.io/npm/v/@astrojs/solid-js.svg?label=%20)](packages/integrations/solid-js/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/deno](packages/integrations/deno) | [![astro version](https://img.shields.io/npm/v/@astrojs/deno.svg?label=%20)](packages/integrations/deno/CHANGELOG.md) | +| [@astrojs/netlify](packages/integrations/netlify) | [![astro version](https://img.shields.io/npm/v/@astrojs/netlify.svg?label=%20)](packages/integrations/netlify/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/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/turbolinks](packages/integrations/turbolinks) | [![astro version](https://img.shields.io/npm/v/@astrojs/turbolinks.svg?label=%20)](packages/integrations/turbolinks/CHANGELOG.md) | + +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](CODE_OF_CONDUCT.md) +- [Open Governance & Voting](GOVERNANCE.md) +- [Project Funding](FUNDING.md) +- [Website](https://astro.build/) + +## Sponsors + +Astro is generously supported by Netlify, Vercel, and several other amazing organizations. + +[❤️ Sponsor Astro! ❤️](FUNDING.md) + +### Platinum Sponsors + + + + + + + + +
NetlifyNetlify + VercelVercel +
+ +### Gold Sponsors + + + + + + + + +
+ + ‹div›RIOTS + + + ‹div›RIOTS + + + + StackUp Digital + + + StackUp Digital + +
+ +### Sponsors + + + + + + + +
SentryQoddi App Platform
diff --git a/assets/social/banner-minimal.png b/assets/social/banner-minimal.png new file mode 100644 index 000000000000..afca6967f18f Binary files /dev/null and b/assets/social/banner-minimal.png differ diff --git a/packages/astro/README.md b/packages/astro/README.md index 1402abae43de..bb521cf29e40 100644 --- a/packages/astro/README.md +++ b/packages/astro/README.md @@ -1,106 +1,47 @@ - - - +
+

+ Astro logo + Astro logo +

+ Astro is a website build tool for the modern web — +
+ powerful developer experience meets lightweight output. +

+

-
-**Astro** is a new kind of static site builder for the modern web—powerful developer experience meets lightweight output. +## Install -
-### [🚀 Read the launch post →](https://astro.build/blog/introducing-astro) +```bash +# Recommended! +npm create astro@latest -### [📚 Learn Astro →](https://docs.astro.build/en/getting-started/) +# Manual: +npm install --save-dev astro +``` -## Project Status +Looking for help? Start with our [Getting Started](https://docs.astro.build/en/getting-started/) guide. -⚠️ **Astro is still beta software—missing features and bugs are to be expected!** We are quickly working our way towards a stable, production-ready v1.0 release, but we are still finalizing some of Astro's APIs. +Looking for quick examples? [Open a starter project](https://astro.new/) right in your browser. -That being said, there are quite a few Astro sites in production already. We're incredibly grateful to everyone who has made an early bet on Astro! +## Documentation -## Quick Start +Visit our [offical documentation](https://docs.astro.build/). - - - - - - - - - - - -
- - 👾 Online - - - 📦 Local -
+## Support -Try Astro in your browser! +Having trouble? Get help in the official [Astro Discord](https://astro.build/chat). +## Contributing -[Launch astro.new →](https://astro.new) +**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! -Get started with Astro using our interactive CLI! +## Sponsors -```bash -npm init astro my-astro-project -``` +Astro is generously supported by [Netlify](https://www.netlify.com/), [Vercel](https://vercel.com/), and several other amazing organizations [listed here.](https://astro.build/) -
+[❤️ Sponsor Astro! ❤️](https://github.com/withastro/astro/blob/main/FUNDING.md) -## Sponsors -You can sponsor Astro's development on [Open Collective](https://opencollective.com/astrodotbuild). Astro is generously supported by the following companies and individuals: - -### Platinum Sponsors - - - - - - - - -
NetlifyNetlify - VercelVercel -
- -### Gold Sponsors - - - - - - - - -
- - ‹div›RIOTS - - - ‹div›RIOTS - - - - StackUp Digital - - - StackUp Digital - -
- -### Sponsors - - - - - - - -
SentryQoddi App Platform