Skip to content

Commit cb6c987

Browse files
authored
docs: update readme (#14)
1 parent 58c37a6 commit cb6c987

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
11
# Essential Next.js (Experimental)
22

3-
Experimental plugin for Next.js applications on Netlify.
3+
_Experimental plugin for Next.js applications on Netlify_
4+
5+
:warning: This plugin is an early alpha, for testing purposes only. It is not feature-complete and should not be used for production sites.
6+
7+
It does not support: i18n, basePath or preview mode, and monorepo support is limited. Do not report issues for sites that use these features.
8+
9+
## Installation
10+
11+
- Remove the existing Essential Next.js plugin (`@netlify/plugin-nextjs`). See the instructions to [uninstall the plugin](https://ntl.fyi/remove-plugin)
12+
- Install the module:
13+
```shell
14+
npm install -D @netlify/plugin-nextjs-experimental
15+
```
16+
- Add to `netlify.toml`:
17+
```toml
18+
[[plugins]]
19+
package = "@netlify/plugin-nextjs-experimental"
20+
```
21+
22+
Unlike the existing plugin, this does not require `target` to be set to `serverless`, so you may remove that. It also does not currently support ESBuild, so if you had manually enabled it in your `netlify.toml`, you will need to remove that.
23+
24+
## Differences from the existing plugin
25+
The main difference from the existing plugin is that it no longer generates a function for each route. Instead it generates one builder function for pages with `fallback="blocking"` or `fallback="true"`, and another function for all other routes. It then uses Next.js's own routing system rather than Netlify's. This means that it support's Next.js rewrites and redirects, and no longer needs to generate a `_redirects` file. You can add your own Netlify redirects to `netlify.toml` if needed, and these will be applied before any Next.js routing.

0 commit comments

Comments
 (0)