2022-05-23 09:58:39 +00:00
![NuxtJS-Logo-Dark ](.github/logo-light.svg#gh-dark-mode-only )
![NuxtJS-Logo-Light ](.github/logo.svg#gh-light-mode-only )
2021-03-28 21:03:37 +00:00
2021-09-10 07:19:33 +00:00
< p >
2022-10-12 10:00:16 +00:00
< 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 = "./LICENSE" > < img src = "https://img.shields.io/github/license/nuxt/framework.svg?style=flat&colorA=002438&colorB=28CF8D" alt = "License" > < / a >
2021-09-10 07:19:33 +00:00
< 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
2022-10-12 10:00:16 +00:00
Welcome to Nuxt 3 repository: **The Intuitive Web Framework** ✨
2022-05-30 12:33:07 +00:00
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.
2021-07-30 16:40:50 +00:00
2021-09-10 07:19:33 +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 > .
2021-09-10 07:19:33 +00:00
< / 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 >
2021-09-10 07:19:33 +00:00
< / 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.
2021-09-10 07:19:33 +00:00
< / 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.
2021-09-10 07:19:33 +00:00
< / p >
< / td >
< / tr >
< / tbody >
< / table >
2021-07-30 16:40:50 +00:00
2021-10-11 12:57:54 +00:00
## 💻 Development
2021-07-30 16:40:50 +00:00
2021-10-11 12:57:54 +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
2022-04-04 06:47:02 +00:00
- Open playground with `npx yarn dev`
2021-07-30 16:40:50 +00:00
2021-10-11 12:57:54 +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
2021-10-11 12:57:54 +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
2021-10-11 12:57:54 +00:00
We recommend to install the [Docus extension ](https://marketplace.visualstudio.com/items?itemName=NuxtLabs.docus ) for VS Code.
2022-03-08 09:27:39 +00:00
- Run `npx yarn stub` once in the root directory
2021-10-11 12:57:54 +00:00
- 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 )