Nuxt/README.md

73 lines
2.4 KiB
Markdown
Raw Normal View History

2021-07-30 16:40:50 +00:00
<h1>
<img src="./.github/logo.svg" height="60" >
2021-07-30 16:40:50 +00:00
</h1>
2021-03-28 21:03:37 +00:00
<p>
<a href="https://github.com/nuxt/framework/actions?query=branch%3Amain+event%3Apush"><img src="https://github.com/nuxt/framework/workflows/ci/badge.svg?branch=main&event=push" alt="CI Status"></a>
<a href="https://www.npmjs.com/package/nuxt3"><img src="https://badgen.net/npm/dm/nuxt3" alt="Downloads"></a>
<a href="https://www.npmjs.com/package/nuxt3"><img src="https://badgen.net/npm/v/nuxt3" alt="Version"></a>
<a href="https://www.npmjs.com/package/nuxt3"><img src="https://badgen.net/npm/license/nuxt3" alt="License"></a>
<a href="https://discord.nuxtjs.org/"><img src="https://badgen.net/badge/Discord/join-us/7289DA" alt="Discord"></a>
</p>
2021-07-30 16:46:25 +00:00
Welcome to Nuxt 3 repository ✨
2021-07-30 16:40:50 +00:00
<table>
<tbody>
<tr>
<td>
<h2>📖 Documentation</h2>
<p>
2021-09-10 08:23:04 +00:00
Read <a href="https://v3.nuxtjs.org">Online Docs</a>.
</p>
</td>
<td>
<h2>🐞 Reporting bugs</h2>
<p>
2021-09-10 08:23:04 +00:00
Check out <a href="https://v3.nuxtjs.org/community/reporting-bugs">Reporting Bugs</a> page.</p>
</td>
</tr>
<tr>
<td>
<h2>💡 Suggestions </h2>
<p>
2021-09-10 08:23:04 +00:00
Check out <a href="https://v3.nuxtjs.org/community/contribution">Contribution</a> page.
</p>
</td>
<td>
<h2>❔ Questions</h2>
<p>
2021-09-10 08:36:52 +00:00
Check out <a href="https://v3.nuxtjs.org/community/getting-help">Getting Help</a> page.
</p>
</td>
</tr>
</tbody>
</table>
2021-07-30 16:40:50 +00:00
## 💻 Development
2021-07-30 16:40:50 +00:00
- Clone repository
- Ensure you have the latest LTS version of Node.js installed
- Install dependencies with `npx yarn install`
- Run `npx yarn stub` to activate passive development
- Open playground with `npx yarn dev`
2021-07-30 16:40:50 +00:00
Learn more about in our documentation on [how to contribute to Nuxt](https://v3.nuxtjs.org/community/contribution).
2021-07-30 16:40:50 +00:00
## 📖 Documentation
2021-03-18 14:26:41 +00:00
2022-04-26 14:45:18 +00:00
We are using [Docus](https://nuxtlabs.com/docus) for documentation (*It is planned to be open sourced in the following weeks*).
2021-03-18 14:26:41 +00:00
We recommend to install the [Docus extension](https://marketplace.visualstudio.com/items?itemName=NuxtLabs.docus) for VS Code.
- Run `npx yarn stub` once in the root directory
- Go into the docs directory: `cd docs`
- Install docs dependencies with `npx yarn install`
- Run `npx yarn dev` to start Docus in development mode
The pages are generated from [docs/content/](./docs/content), you can start editing them to start helping us on documenting Nuxt 3 💚
## License
2022-04-20 21:02:02 +00:00
[MIT](./LICENSE)