Skip to content

Commit da8db8c

Browse files
committed
docs: small fixes
1 parent 792f8f3 commit da8db8c

1 file changed

Lines changed: 20 additions & 18 deletions

File tree

README.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
1-
# Nuxt Bridge
1+
# 🌉 Nuxt Bridge
22

33
> Experience Nuxt 3 features on existing Nuxt 2 projects.
44
5-
If you're starting a fresh Nuxt 3 project, please skip this section and go to [Nuxt 3 Installation](https://v3.nuxtjs.org/getting-started/quick-start).
6-
7-
**Note:** Nuxt Bridge provides identical features to Nuxt 3 ([Nuxt 3 docs](https://v3.nuxtjs.org/guide/features/views)) but there are some limitations, notably that `useAsyncData` and `useFetch` composables are not available. Please read the rest of this page for details.
8-
95
Bridge is a forward-compatibility layer that allows you to experience many of the new Nuxt 3 features by simply installing and enabling a Nuxt module.
106

117
Using Nuxt Bridge, you can make sure your project is (almost) ready for Nuxt 3 and have the best developer experience without needing a major rewrite or risk breaking changes.
128

9+
⚠️ **Note:** Nuxt Bridge provides identical features to Nuxt 3 ([Nuxt 3 docs](https://v3.nuxtjs.org/guide/features/views)) but there are some limitations, notably that `useAsyncData` and `useFetch` composables are not available. Please read the rest of this page for details.
10+
11+
🌱 **Note:** If you're starting a fresh Nuxt project, please skip this module and directly go to the [Nuxt 3 Installation](https://v3.nuxtjs.org/getting-started/quick-start).
12+
13+
1314
## Installation
1415

1516
### Upgrade to the latest Nuxt 2
@@ -23,11 +24,11 @@ Make sure your dev server (`nuxt dev`) isn't running, remove any package lock fi
2324

2425
Then, reinstall your dependencies:
2526

26-
```bash [Yarn]
27+
```bash
28+
# Using yarn
2729
yarn install
28-
```
2930

30-
```bash [NPM]
31+
# Using npm
3132
npm install
3233
```
3334

@@ -37,11 +38,12 @@ Once the installation is complete, make sure both development and production bui
3738

3839
Install `@nuxt/bridge-edge` as a development dependency:
3940

40-
```bash [Yarn]
41+
```bash
42+
43+
# Using yarn
4144
yarn add --dev @nuxt/bridge@npm:@nuxt/bridge-edge
42-
```
4345

44-
```bash [NPM]
46+
# Using npm
4547
npm install -D @nuxt/bridge@npm:@nuxt/bridge-edge
4648
```
4749

@@ -51,7 +53,7 @@ You will also need to update your scripts within your `package.json` to reflect
5153

5254
### Nuxi
5355

54-
Nuxt 3 introduced the new Nuxt CLI command [`nuxi`](/api/commands/add). Update your scripts as follows to leverage the better support from Nuxt Bridge:
56+
Nuxt 3 introduced the new Nuxt CLI command [`nuxi`](https://v3.nuxtjs.org/api/commands/add). Update your scripts as follows to leverage the better support from Nuxt Bridge:
5557

5658
```diff
5759
{
@@ -126,11 +128,11 @@ In case you need to extend options provided by `./.nuxt/tsconfig.json` further,
126128

127129
## Migrate Composition API
128130

129-
If you were using `@vue/composition-api` or `@nuxtjs/composition-api`, please read the [composition api migration guide](/bridge/bridge-composition-api).
131+
If you were using `@vue/composition-api` or `@nuxtjs/composition-api`, please read the [composition api migration guide](https://v3.nuxtjs.org/bridge/bridge-composition-api).
130132

131133
### Migrate from CommonJS to ESM
132134

133-
Nuxt 3 natively supports TypeScript and ECMAScript Modules. Please check [Native ES Modules](/guide/going-further/esm) for more info and upgrading.
135+
Nuxt 3 natively supports TypeScript and ECMAScript Modules. Please check [Native ES Modules](https://v3.nuxtjs.org/guide/going-further/esm) for more info and upgrading.
134136

135137
## Remove incompatible and obsolete modules
136138

@@ -139,8 +141,8 @@ Nuxt 3 natively supports TypeScript and ECMAScript Modules. Please check [Native
139141
- Remove `@nuxt/typescript-build`: Bridge enables same functionality
140142
- Remove `@nuxt/typescript-runtime` and `nuxt-ts`: Nuxt 2 has built-in runtime support
141143
- Remove `@nuxt/nitro`: Bridge injects same functionality
142-
- Remove `@vue/composition-api` from your dependencies ([migration guide](/bridge/bridge-composition-api)).
143-
- Remove `@nuxtjs/composition-api` from your dependencies (and from your modules in `nuxt.config`) ([migration guide](/bridge/bridge-composition-api)).
144+
- Remove `@vue/composition-api` from your dependencies ([migration guide](https://v3.nuxtjs.org/bridge/bridge-composition-api)).
145+
- Remove `@nuxtjs/composition-api` from your dependencies (and from your modules in `nuxt.config`) ([migration guide](https://v3.nuxtjs.org/bridge/bridge-composition-api)).
144146

145147
## Exclude built Nitro folder from git
146148

@@ -164,7 +166,7 @@ export default defineNuxtConfig({
164166

165167
You can now migrate to the Nuxt 3 plugins API, which is slightly different in format from Nuxt 2.
166168

167-
Plugins now take only one argument (`nuxtApp`). You can find out more in [the docs](/guide/directory-structure/plugins).
169+
Plugins now take only one argument (`nuxtApp`). You can find out more in [the docs](https://v3.nuxtjs.org/guide/directory-structure/plugins).
168170

169171
```js
170172
export default defineNuxtPlugin(nuxtApp => {
@@ -204,7 +206,7 @@ export default defineNuxtConfig({
204206
This `useHead` composable uses `@vueuse/head` under the hood (rather than `vue-meta`) to manipulate your `<head>`.
205207
Accordingly, we recommend not to use both the native Nuxt 2 `head()` properties as well as `useHead`, as they may conflict.
206208

207-
For more information on how to use this composable, see [the docs](/guide/features/head-management).
209+
For more information on how to use this composable, see [the docs](https://v3.nuxtjs.org/guide/features/head-management).
208210

209211
## Feature Flags
210212

0 commit comments

Comments
 (0)