Skip to content
This repository has been archived by the owner on Apr 6, 2023. It is now read-only.

Commit

Permalink
chore: update
Browse files Browse the repository at this point in the history
  • Loading branch information
Atinux committed Oct 6, 2022
1 parent 9a30cca commit b22054f
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 7 deletions.
2 changes: 2 additions & 0 deletions .markdownlint.yml
Expand Up @@ -10,3 +10,5 @@ MD024:
MD025: false
# Allow inline HTML
MD033: false
# Allow non blank lines around list
MD032: false
16 changes: 10 additions & 6 deletions docs/content/1.getting-started/1.introduction.md
Expand Up @@ -11,8 +11,8 @@ Nuxt is an open-source framework under MIT license for building modern and perfo
## What is Nuxt?

To understand what Nuxt is, we need to understand what we need to create a modern application:
::list{type=success}

::list{type=success}
- A JavaScript framework to bring reactivity and web components, we chose [Vue.js](https://v3.vuejs.org).
- A bundler to support hot module replacement in development and bundle your code for production, we support both [webpack 5](https://webpack.js.org/) and [Vite](https://vitejs.dev/).
- A transpiler to write the latest JavaScript syntax while supporting legacy browsers, we use [esbuild](https://esbuild.github.io) for that.
Expand All @@ -26,33 +26,37 @@ Nuxt takes care of this and provides both frontend and backend functionality so

### View engine

Nuxt uses Vue.js as a view engine. All Vue 3 capabilities are available in Nuxt. You can read about the details of the Vue integration with Nuxt in the [Key Concepts section](/concepts/vuejs-development).
Nuxt uses Vue.js as a view engine. All Vue 3 capabilities are available in Nuxt. You can read about the details of the Vue integration with Nuxt in the [Key Concepts section](/guide/concepts/vuejs-development).

### Automation and conventions

Nuxt uses conventions and an opinionated directory structure to automate repetitive tasks and allow developers to focus on what matters. The configuration file can still customize and override its default behaviors.

::list{type=success}
- Auto-imports
- File-system routing and API layer
- Data-fetching utilities
- Zero-config Typescript support
- Configured build tools
::

::alert{type="info"}
Discover more in the [Key concepts section](/concepts/auto-imports).
Discover more in the [Key concepts section](/guide/concepts/auto-imports).
::

### Rendering modes

Nuxt offers different rendering modes to accomodate various use-cases:

::list{type=success}
- Universal rendering (Server-side rendering and hydration)
- Client-side only rendering
- Full Static site generation
- Hybrid rendering (per-routes caching strategy)
::

::alert{type="info"}
Read more about [Nuxt rendering modes](/concepts/rendering-modes).
Read more about [Nuxt rendering modes](/guide/concepts/rendering).
::

### Server engine
Expand Down Expand Up @@ -80,14 +84,14 @@ Discover more in the [deployment section](/getting-started/deployment).
A module system allows to extend Nuxt with custom features and integrations with third-party services.

::alert{type="info"}
Discover more about [modules](/concepts/modules).
Discover more about [modules](/guide/concepts/modules).
::

### Architecture

Nuxt is composed of different [core packages](https://github.com/nuxt/framework/tree/main/packages):
::list{type=info}

::list{type=info}
- Core Engine: [nuxt](https://github.com/nuxt/framework/tree/main/packages/nuxt)
- Bundlers: [@nuxt/vite-builder](https://github.com/nuxt/framework/tree/main/packages/vite) and [@nuxt/webpack-builder](https://github.com/nuxt/framework/tree/main/packages/webpack)
- Command line interface: [nuxi](https://github.com/nuxt/framework/tree/main/packages/nuxi)
Expand Down
2 changes: 1 addition & 1 deletion docs/content/5.community/3.contribution.md
Expand Up @@ -124,7 +124,7 @@ We recommend the following libraries which are used throughout the ecosystem:

#### Use ESM Syntax and Default to `type: module`

Most of the Nuxt ecosystem can consume ESM directly. In general we advocate that you avoid using CJS-specific code, such as `__dirname` and `require` statements. You can [read more about ESM](/concepts/esm).
Most of the Nuxt ecosystem can consume ESM directly. In general we advocate that you avoid using CJS-specific code, such as `__dirname` and `require` statements. You can [read more about ESM](/guide/concepts/esm).

#### What's Corepack

Expand Down

0 comments on commit b22054f

Please sign in to comment.