1
- ![ Next.js Runtime] ( https://github.com/netlify/next-runtime/raw/main/ next-js-runtime.png)
1
+ ![ Next.js Runtime] ( next-js-runtime.png )
2
2
3
- # ` @netlify/plugin-nextjs `
3
+ # Next.js Runtime
4
4
5
5
<p align =" center " >
6
6
<a aria-label =" npm version " href =" https://www.npmjs.com/package/@netlify/plugin-nextjs " >
@@ -16,3 +16,63 @@ Netlify. You should not normally need to install it yourself, as it is used auto
16
16
builds of Next.js sites. See
17
17
[ the docs for using Next.js on Netlify] ( https://docs.netlify.com/frameworks/next-js/overview/ ) for
18
18
more details.
19
+
20
+ Next.js is supported natively on Netlify, and in most cases you will not need to install or
21
+ configure anything. This repo includes the packages used to support Next.js on Netlify.
22
+
23
+ ## Prerequisites
24
+
25
+ - Next.js 13.5 or later
26
+ - Node.js 18 or later
27
+ - The latest version of the [ Netlify CLI] ( https://docs.netlify.com/cli/get-started/ )
28
+
29
+ ## Deploying
30
+
31
+ If you build on Netlify, the Next.js Runtime will work with no additional configuration.
32
+
33
+ ## Manually installing the Next.js Runtime
34
+
35
+ The Next.js Runtime installs automatically for new Next.js sites on Netlify. You can also install it
36
+ manually in the following ways:
37
+
38
+ ### From the UI (Recommended)
39
+
40
+ You can go to the [ UI] ( https://app.netlify.com/plugins/@netlify/plugin-nextjs/install ) and choose
41
+ the site to install the Next.js Runtime on. This method is recommended because you will benefit from
42
+ auto-upgrades to important fixes and feature updates.
43
+
44
+ ### From ` npm `
45
+
46
+ ``` shell
47
+ npm install -D @netlify/plugin-nextjs
48
+ ```
49
+
50
+ ...then add the following to your ` netlify.toml ` file:
51
+
52
+ ``` toml
53
+ [[plugins ]]
54
+ package = " @netlify/plugin-nextjs"
55
+ ```
56
+
57
+ This method is recommended if you wish to pin the Next.js Runtime to a specific version.
58
+
59
+ ## v4
60
+
61
+ If you are using Next.js 10-13.4 or Node.js < 18, you must use v4 of the Next.js Runtime.
62
+
63
+ If you are still using v4, you can find
64
+ [ its README here] ( https://github.com/netlify/next-runtime/blob/v4/README.md ) and the
65
+ [ v4 Runtime docs here] ( https://docs.netlify.com/frameworks/next-js/runtime-v4/overview/ ) .
66
+
67
+ ### Upgrading from v4 to v5
68
+
69
+ To upgrade from v4 to v5, please visit
70
+ [ the v5 documentation] ( https://docs.netlify.com/frameworks/next-js/overview/ ) .
71
+
72
+ ## Feedback
73
+
74
+ If you think you have found a bug in Next.js on Netlify,
75
+ [ please open an issue] ( https://github.com/netlify/next-runtime/issues ) . If you have comments or
76
+ feature requests, [ see the discussion board] ( https://github.com/netlify/next-runtime/discussions )
77
+
78
+ Please note that v4 will only receive security fixes and critical bug fixes.
0 commit comments