Zengtudor/Nuxt: Nuxt is an intuitive and extendable way to create type-safe, performant and production-grade full-stack web apps and websites with Vue 3. - Nuxt

mirror of https://github.com/nuxt/nuxt.git synced 2024-11-25 15:15:19 +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.

csr full-stack hybrid node nuxt server-rendering ssg ssr static-site-generator universal vue

Go to file

Daniel Roe d25dafef49 fix(vite): add type-checker to client build for `ssr: false` (#7930 ) Co-authored-by: Sébastien Chopin <seb@nuxtjs.com>		2022-10-03 15:37:36 +02:00
.github	ci: crawl docs site for new deployments to track broken links (#7473 )	2022-09-13 18:06:15 +02:00
.yarn	chore(deps): update all non-major dependencies (#6913 )	2022-08-25 09:15:47 +02:00
docs	docs: add newline at end of sass import (#7810 )	2022-09-30 08:14:38 +02:00
examples	docs(examples): optimize writing of `: ?` (#7928 )	2022-09-30 14:55:32 +02:00
packages	fix(vite): add type-checker to client build for `ssr: false` (#7930 )	2022-10-03 15:37:36 +02:00
playground	feat(nuxt, kit): auto import `defineNuxtConfig` (#7497 )	2022-09-14 13:10:10 +02:00
scripts	ci: crawl docs site for new deployments to track broken links (#7473 )	2022-09-13 18:06:15 +02:00
test	feat(nuxt): support `redirect` within page metadata (#7746 )	2022-09-22 15:54:34 +02:00
.editorconfig	chore: upgrade to monorepo	2021-03-18 15:26:41 +01:00
.eslintignore	chore(lint): enable linting on docs files (#1638 )	2021-11-02 13:39:00 +01:00
.eslintrc	feat(nuxt): automatically generate unique keys for keyed composables (#4955 )	2022-07-07 18:26:04 +02:00
.gitignore	build: remove nuxt.d.ts from `.gitignore`	2022-08-11 14:40:51 +02:00
.gitpod.yml	chore: add `.gitpod.yml` (#866 )	2021-10-13 14:07:14 +02:00
.markdownlint.yml	chore(docs): add code format using markdownlint (#1498 ) (#1556 )	2021-10-29 13:26:01 +02:00
.markdownlintignore	feat(nuxt3): add middleware via route meta (#2858 )	2022-01-25 13:29:11 +01:00
.yarnrc.yml	chore(deps): update all non-major dependencies (#6913 )	2022-08-25 09:15:47 +02:00
changelog.config.json	v3.0.0-rc.2 (#4763 )	2022-05-02 22:47:05 +02:00
lerna.json	v3.0.0-rc.11 (#7565 )	2022-09-20 18:38:31 +02:00
LICENSE	chore: add local mit license	2022-04-20 23:02:02 +02:00
package.json	chore: clean up some root workspace dependencies (#7931 )	2022-10-03 15:35:52 +02:00
README.md	docs: update badges and add a descrition	2022-05-30 14:33:07 +02:00
renovate.json	chore: ignore vue-tsc upgrade until fixed	2022-08-10 15:32:48 +02:00
SECURITY.md	docs: add notes about reporting security issues (#4895 )	2022-06-17 10:00:37 +02:00
tsconfig.json	refactor: enable strict type checking everywhere (#6943 )	2022-08-26 17:47:29 +02:00
vitest.config.ts	feat(vite)!: upgrade vite to v3 (#5398 )	2022-07-21 12:44:33 +02:00
yarn.lock	chore: clean up some root workspace dependencies (#7931 )	2022-10-03 15:35:52 +02:00

README.md

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.

📖 Documentation

Read Online Docs.

🐞 Reporting bugs

Check out Reporting Bugs page.

💡 Suggestions

Check out Contribution page.

❔ Questions

Check 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 💚

License

MIT