mirror of
https://github.com/nuxt/nuxt.git
synced 2024-11-15 18:34:50 +00:00
Nuxt is an intuitive and extendable way to create type-safe, performant and production-grade full-stack web apps and websites with Vue 3.
.github | ||
.yarn | ||
docs | ||
examples | ||
packages | ||
playground | ||
scripts | ||
test | ||
.editorconfig | ||
.eslintignore | ||
.eslintrc | ||
.gitignore | ||
.gitpod.yml | ||
.markdownlint.yml | ||
.markdownlintignore | ||
.yarnrc.yml | ||
changelog.config.json | ||
lerna.json | ||
LICENSE | ||
package.json | ||
README.md | ||
renovate.json | ||
SECURITY.md | ||
tsconfig.json | ||
vitest.config.ts | ||
yarn.lock |
Welcome to Nuxt 3 repository: The Hybrid Vue 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?" section of our documentation.
📖 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 stub
to activate passive development - Open playground with
npx yarn dev
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 in the following weeks).
We recommend to install the Docus extension 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/, you can start editing them to start helping us on documenting Nuxt 3 💚