chore: update readme design (#9048)

Co-authored-by: Daniel Roe <daniel@roe.dev>
This commit is contained in:
Sébastien Chopin 2022-11-16 12:19:41 +01:00 committed by Pooya Parsa
parent b5f75b5ec7
commit 731c43365b
11 changed files with 94 additions and 21 deletions

BIN
.github/assets/banner.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 133 KiB

1
.github/assets/discord.svg vendored Normal file
View File

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 24 24"><path fill="#A1A1AA" d="M19.27 5.33C17.94 4.71 16.5 4.26 15 4a.09.09 0 0 0-.07.03c-.18.33-.39.76-.53 1.09a16.09 16.09 0 0 0-4.8 0c-.14-.34-.35-.76-.54-1.09c-.01-.02-.04-.03-.07-.03c-1.5.26-2.93.71-4.27 1.33c-.01 0-.02.01-.03.02c-2.72 4.07-3.47 8.03-3.1 11.95c0 .02.01.04.03.05c1.8 1.32 3.53 2.12 5.24 2.65c.03.01.06 0 .07-.02c.4-.55.76-1.13 1.07-1.74c.02-.04 0-.08-.04-.09c-.57-.22-1.11-.48-1.64-.78c-.04-.02-.04-.08-.01-.11c.11-.08.22-.17.33-.25c.02-.02.05-.02.07-.01c3.44 1.57 7.15 1.57 10.55 0c.02-.01.05-.01.07.01c.11.09.22.17.33.26c.04.03.04.09-.01.11c-.52.31-1.07.56-1.64.78c-.04.01-.05.06-.04.09c.32.61.68 1.19 1.07 1.74c.03.01.06.02.09.01c1.72-.53 3.45-1.33 5.25-2.65c.02-.01.03-.03.03-.05c.44-4.53-.73-8.46-3.1-11.95c-.01-.01-.02-.02-.04-.02zM8.52 14.91c-1.03 0-1.89-.95-1.89-2.12s.84-2.12 1.89-2.12c1.06 0 1.9.96 1.89 2.12c0 1.17-.84 2.12-1.89 2.12zm6.97 0c-1.03 0-1.89-.95-1.89-2.12s.84-2.12 1.89-2.12c1.06 0 1.9.96 1.89 2.12c0 1.17-.83 2.12-1.89 2.12z"/></svg>

After

Width:  |  Height:  |  Size: 1.0 KiB

BIN
.github/assets/documentation.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 62 KiB

BIN
.github/assets/examples.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

1
.github/assets/github.svg vendored Normal file
View File

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 24 24"><path fill="#A1A1AA" d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5c.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34c-.46-1.16-1.11-1.47-1.11-1.47c-.91-.62.07-.6.07-.6c1 .07 1.53 1.03 1.53 1.03c.87 1.52 2.34 1.07 2.91.83c.09-.65.35-1.09.63-1.34c-2.22-.25-4.55-1.11-4.55-4.92c0-1.11.38-2 1.03-2.71c-.1-.25-.45-1.29.1-2.64c0 0 .84-.27 2.75 1.02c.79-.22 1.65-.33 2.5-.33c.85 0 1.71.11 2.5.33c1.91-1.29 2.75-1.02 2.75-1.02c.55 1.35.2 2.39.1 2.64c.65.71 1.03 1.6 1.03 2.71c0 3.82-2.34 4.66-4.57 4.91c.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg>

After

Width:  |  Height:  |  Size: 682 B

BIN
.github/assets/modules.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

BIN
.github/assets/questions.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

BIN
.github/assets/reporting-bugs.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 53 KiB

BIN
.github/assets/suggestions.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

1
.github/assets/twitter.svg vendored Normal file
View File

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" width="39.4" height="32" viewBox="0 0 1231.051 1000"><path fill="#A1A1AA" d="M1231.051 118.453q-51.422 76.487-126.173 130.403q.738 14.46.738 32.687q0 101.273-29.53 202.791q-29.53 101.519-90.215 194.343q-60.685 92.824-144.574 164.468q-83.889 71.644-201.677 114.25q-117.788 42.606-252.474 42.606q-210.2 0-387.147-113.493q31.406 3.495 60.242 3.495q175.605 0 313.687-108.177q-81.877-1.501-146.654-50.409q-64.777-48.907-89.156-124.988q24.097 4.59 47.566 4.59q33.782 0 66.482-8.812q-87.378-17.5-144.975-87.04q-57.595-69.539-57.595-160.523v-3.126q53.633 29.696 114.416 31.592q-51.762-34.508-82.079-89.999q-30.319-55.491-30.319-120.102q0-68.143 34.151-126.908q95.022 116.607 230.278 186.392q135.258 69.786 290.212 77.514q-6.609-27.543-6.621-57.485q0-104.546 73.994-178.534Q747.623 0 852.169 0q109.456 0 184.392 79.711q85.618-16.959 160.333-61.349q-28.785 90.59-110.933 139.768q75.502-8.972 145.088-39.677z"/></svg>

After

Width:  |  Height:  |  Size: 947 B

112
README.md
View File

@ -1,43 +1,106 @@
![NuxtJS-Logo-Dark](.github/logo-light.svg#gh-dark-mode-only)
![NuxtJS-Logo-Light](.github/logo.svg#gh-light-mode-only) [![Nuxt banner](./.github/assets/banner.png)](https://nuxt.com)
# 👋 Welcome to Nuxt
Nuxt's goal is to make web development intuitive and performant, with a great developer experience.<br>Learn more in the ['What is Nuxt?'](https://nuxt.com/docs/getting-started/introduction) section of our documentation.
<p> <p>
<a href="https://www.npmjs.com/package/nuxt/v/rc"><img src="https://img.shields.io/npm/v/nuxt/rc.svg?style=flat&colorA=002438&colorB=28CF8D" alt="Version"></a> <a href="https://www.npmjs.com/package/nuxt/v/rc"><img src="https://img.shields.io/npm/v/nuxt/rc.svg?style=flat&colorA=002438&colorB=28CF8D" alt="Version"></a>
<a href="https://www.npmjs.com/package/nuxt/v/rc"><img src="https://img.shields.io/npm/dm/nuxt.svg?style=flat&colorA=002438&colorB=28CF8D" alt="Downloads"></a> <a href="https://www.npmjs.com/package/nuxt/v/rc"><img src="https://img.shields.io/npm/dm/nuxt.svg?style=flat&colorA=002438&colorB=28CF8D" alt="Downloads"></a>
<a href="./LICENSE"><img src="https://img.shields.io/github/license/nuxt/framework.svg?style=flat&colorA=002438&colorB=28CF8D" alt="License"></a> <a href="./LICENSE"><img src="https://img.shields.io/github/license/nuxt/framework.svg?style=flat&colorA=002438&colorB=28CF8D" alt="License"></a>
<a href="https://discord.nuxtjs.org/"><img src="https://badgen.net/badge/Discord/join-us/7289DA" alt="Discord"></a>
</p> </p>
Welcome to Nuxt 3 repository: **The Intuitive Web Framework**
Nuxt's goal is to make web development intuitive and performant with a great developer experience in mind, learn more in the ["What is Nuxt?"](https://v3.nuxtjs.org/guide/concepts/introduction) section of our documentation.
<table> <table>
<thead>
<tr>
<th width="2000" colspan="2">
</th>
</tr>
</thead>
<tbody> <tbody>
<tr> <tr>
<td> <td width="80" align="center" valign="top">
<h2>📖 Documentation</h2> <br>
<p> <a href="https://nuxt.com/docs"><img src="./.github/assets/documentation.png"></a>
Read <a href="https://v3.nuxtjs.org">Online Docs</a>.
</p>
</td> </td>
<td> <td valign="top">
<h2>🐞 Reporting bugs</h2> <h3>Documentation</h3>
<p> <p>
Check out <a href="https://v3.nuxtjs.org/community/reporting-bugs">Reporting Bugs</a> page.</p> We highly recommend you take a look at <a href="https://nuxt.com">the Nuxt documentation</a> to level up.
</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td> <td width="80" align="center" valign="top">
<h2>💡 Suggestions </h2> <br>
<a href="https://nuxt.com/modules"><img src="./.github/assets/modules.png"></a>
</td>
<td valign="top">
<h3>Modules</h3>
<p> <p>
Check out <a href="https://v3.nuxtjs.org/community/contribution">Contribution</a> page. Discover our <a href="https://nuxt.com/modules">list of modules</a> to supercharge your Nuxt project. Created by the Nuxt team and community.
</p> </p>
</td> </td>
</tr>
<tr>
<td width="80" align="center" valign="top">
<br>
<a href="https://nuxt.com/docs/examples/hello-world"><img src="./.github/assets/examples.png"></a>
</td>
<td> <td>
<h2>❔ Questions</h2> <h3>Examples</h3>
<p> <p>
Check out <a href="https://v3.nuxtjs.org/community/getting-help">Getting Help</a> page. Explore different ways of using Nuxt features and get inspired with <a href="https://nuxt.com/docs/examples/hello-world">our list of examples</a>.
</p>
</td>
</tr>
</tbody>
</table>
<table>
<thead>
<tr>
<th width="2000" colspan="2">
</th>
</tr>
</thead>
<tbody>
<tr>
<td width="80" align="center" valign="top">
<br>
<a href="https://nuxt.com/docs/community/reporting-bugs"><img src="./.github/assets/reporting-bugs.png"></a>
</td>
<td valign="top">
<h3>Reporting bugs</h3>
<p>
Check out the <a href="https://nuxt.com/docs/community/reporting-bugs">Reporting Bugs</a> page.</p>
</p>
</td>
</tr>
<tr>
<td width="80" align="center" valign="top">
<br>
<a href="https://nuxt.com/docs/community/contribution"><img src="./.github/assets/suggestions.png"></a>
</td>
<td valign="top">
<h3>Suggestions</h3>
<p>
Check out the <a href="https://nuxt.com/docs/community/contribution">Contribution</a> page.
</p>
</td>
</tr>
<tr>
<td width="80" align="center" valign="top">
<br>
<a href="https://nuxt.com/docs/community/getting-help"><img src="./.github/assets/questions.png"></a>
</td>
<td valign="top">
<h3>Questions</h3>
<p>
Check out the <a href="https://nuxt.com/docs/community/getting-help">Getting Help</a> page.
</p> </p>
</td> </td>
</tr> </tr>
@ -46,8 +109,15 @@ Nuxt's goal is to make web development intuitive and performant with a great dev
## Local Development ## Local Development
Follow the docs to [Set Up Your Local Development Environment](https://v3.nuxtjs.org/community/framework-contribution#set-up-your-local-development-environment) to contribute to the framework and documentation. Follow the docs to [Set Up Your Local Development Environment](https://nuxt.com/docs/community/framework-contribution#set-up-your-local-development-environment) to contribute to the framework and documentation.
## Follow us
<p valign="center">
<a href="https://chat.nuxt.dev"><img width="20px" src="./.github/assets/discord.svg" alt="Discord"></a>&nbsp;&nbsp;<a href="https://twitter.nuxt.dev"><img width="20px" src="./.github/assets/twitter.svg" alt="Twitter"></a>&nbsp;&nbsp;<a href="https://github.nuxt.dev"><img width="20px" src="./.github/assets/github.svg" alt="GitHub"></a>
</p>
## License ## License
[MIT](./LICENSE) [MIT](./LICENSE)