diff options
| -rw-r--r--[l---------] | README.md | 128 | ||||
| -rw-r--r-- | assets/social/banner-minimal.png | bin | 0 -> 42358 bytes | |||
| -rw-r--r-- | packages/astro/README.md | 117 |
3 files changed, 156 insertions, 89 deletions
diff --git a/README.md b/README.md index 6007e27af..ece0fd865 120000..100644 --- a/README.md +++ b/README.md @@ -1 +1,127 @@ -packages/astro/README.md
\ No newline at end of file +<br/> +<p align="center"> + <img src="assets/brand/logo-square-black.png#gh-light-mode-only" alt="Astro logo" width="120"> + <img src="assets/brand/logo-square-white.png#gh-dark-mode-only" alt="Astro logo" width="120"> + <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-js) | [](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/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) | + +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 + +<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> diff --git a/assets/social/banner-minimal.png b/assets/social/banner-minimal.png Binary files differnew file mode 100644 index 000000000..afca6967f --- /dev/null +++ b/assets/social/banner-minimal.png diff --git a/packages/astro/README.md b/packages/astro/README.md index 1402abae4..bb521cf29 100644 --- a/packages/astro/README.md +++ b/packages/astro/README.md @@ -1,106 +1,47 @@ -<a href="https://astro.build"> - <img src="https://raw.githubusercontent.com/withastro/astro/main/assets/social/banner.svg" /> -</a> +<br/> +<p align="center"> + <img src="../../assets/brand/logo-square-black.png#gh-light-mode-only" alt="Astro logo" width="120"> + <img src="../../assets/brand/logo-square-white.png#gh-dark-mode-only" alt="Astro logo" width="120"> + <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> -<div center> -**Astro** is a new kind of static site builder for the modern web—powerful developer experience meets lightweight output. +## Install -</div> -### [🚀 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/). -<table> - <tbody> - <tr> - <td> - <img width="441" height="1px"> - <strong>👾 Online</strong> - </td> - <td> - <img width="441" height="1px"> - <strong>📦 Local</strong> - </td> - </tr> - <tr> -<td> +## 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. -</td> -<td> +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/) -</td> - </tr> - </tbody> -</table> +[❤️ 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 - -<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> |
