mirror of https://github.com/nuxt/nuxt.git
a5fcd5a976
|
||
|---|---|---|
| .github | ||
| .yarn | ||
| docs | ||
| examples | ||
| packages | ||
| playground | ||
| scripts | ||
| test | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc | ||
| .gitignore | ||
| .gitpod.yml | ||
| .markdownlint.yml | ||
| .markdownlintignore | ||
| .yarnrc.yml | ||
| README.md | ||
| lerna.json | ||
| package.json | ||
| renovate.json | ||
| tsconfig.json | ||
| yarn.lock | ||
README.md
Welcome to Nuxt 3 repository ✨
📖 DocumentationRead Online Docs. |
🐞 Reporting bugsCheck out Reporting Bugs page. |
💡 SuggestionsCheck out Contribution page. |
❔ QuestionsCheck out Getting Help page. |
💻 Development
- Clone repository
- Ensure you have the latest LTS version of Node.js installed
- Install dependencies with
npx yarn install - Run
npx yarn stubto activate passive development - Open playground with
npx yarn play
Learn more about in our documentation on how to contribute to Nuxt.
📖 Documentation
We are using Docus for documentation (It is planned to be open sourced it in the following weeks).
We recommend to install the Docus extension for VS Code.
- Go into the docs directory:
cd docs - Install docs dependencies with
npx yarn install - Run
npx yarn devto start Docus in development mode
The pages are generated from docs/content/, you can start editing them to start helping us on documenting Nuxt 3 💚