Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 793ea73

Browse files
authoredMar 12, 2024
docs: update readme (#2449)
1 parent 84b6ab8 commit 793ea73

File tree

1 file changed

+19
-8
lines changed

1 file changed

+19
-8
lines changed
 

‎README.md

+19-8
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
# Next.js Runtime
44

5+
> [!NOTE]
6+
> Next.js Runtime v5 is available for early access! Please note that this repository is for the current version (v4) of
7+
> the Next.js Runtime, and the early access version is not yet available in this repository.
8+
> [Learn more](https://docs.netlify.com/frameworks/next-js/overview/).
9+
510
Next.js is supported natively on Netlify, and in most cases you will not need to install or configure anything. This
611
repo includes the packages used to support Next.js on Netlify.
712

@@ -16,10 +21,10 @@ commands separately will not work, because the Next.js Runtime will not generate
1621
If you use [`next/image`](https://nextjs.org/docs/basic-features/image-optimization), your images will be automatically
1722
optimized at runtime, ensuring that they are served at the best size and format. The image will be processed on the
1823
first request which means it may take longer to load, but the generated image is then cached and served as a static file
19-
to future visitors. By default, Next.js will deliver WebP images if the browser supports it. WebP is a modern image format
20-
with wide browser support that will usually generate smaller files than PNG or JPG. Additionally, you can enable AVIF
21-
format, which is often even smaller in filesize than WebP. The drawback is that with particularly large images, AVIF images may
22-
take too long to generate, and the function times-out. You can configure
24+
to future visitors. By default, Next.js will deliver WebP images if the browser supports it. WebP is a modern image
25+
format with wide browser support that will usually generate smaller files than PNG or JPG. Additionally, you can enable
26+
AVIF format, which is often even smaller in filesize than WebP. The drawback is that with particularly large images,
27+
AVIF images may take too long to generate, and the function times-out. You can configure
2328
[the supported image formats](https://nextjs.org/docs/api-reference/next/image#acceptable-formats) in your
2429
`next.config.js` file.
2530

@@ -91,7 +96,10 @@ Note that Netlify has a minimum TTL of 60 seconds for revalidation.
9196

9297
## Disable Static 404 on Dynamic Routes with fallback:false
9398

94-
Currently when hitting a non-prerendered path with `fallback=false` it will default to a 404 page. You can now change this default setting by using the environemnt variable `LEGACY_FALLBACK_FALSE=true`. With the environment variable set, those non-prerendered paths will now be routed through using the ISR Handler and will allow you to add redirects for those non-prerendered paths.
99+
Currently when hitting a non-prerendered path with `fallback=false` it will default to a 404 page. You can now change
100+
this default setting by using the environemnt variable `LEGACY_FALLBACK_FALSE=true`. With the environment variable set,
101+
those non-prerendered paths will now be routed through using the ISR Handler and will allow you to add redirects for
102+
those non-prerendered paths.
95103

96104
## Use with `next export`
97105

@@ -190,13 +198,15 @@ npm test
190198

191199
### End-to-end tests
192200

193-
In order to run the end-to-end (E2E) tests, you'll need to be logged in to Netlify. You can do this using the [Netlify CLI](https://github.com/netlify/cli) with the command:
201+
In order to run the end-to-end (E2E) tests, you'll need to be logged in to Netlify. You can do this using the
202+
[Netlify CLI](https://github.com/netlify/cli) with the command:
194203

195204
```shell
196205
netlify login
197206
```
198207

199-
Alternatively, you can set an environment variable `NETLIFY_AUTH_TOKEN` to a valid Netlify personal access token. This can be obtained from the [Netlify UI](https://docs.netlify.com/cli/get-started/#obtain-a-token-in-the-netlify-ui).
208+
Alternatively, you can set an environment variable `NETLIFY_AUTH_TOKEN` to a valid Netlify personal access token. This
209+
can be obtained from the [Netlify UI](https://docs.netlify.com/cli/get-started/#obtain-a-token-in-the-netlify-ui).
200210

201211
Then run the E2E tests if logged in:
202212

@@ -210,7 +220,8 @@ Or if using an access token:
210220
NETLIFY_AUTH_TOKEN=your-token-here npm run test:next
211221
```
212222

213-
_Note: The E2E tests will be deployed to a Netlify owned site. To deploy to your own site then set the environment variable `NETLIFY_SITE_ID` to your site ID._
223+
_Note: The E2E tests will be deployed to a Netlify owned site. To deploy to your own site then set the environment
224+
variable `NETLIFY_SITE_ID` to your site ID._
214225

215226
## Feedback
216227

0 commit comments

Comments
 (0)
Please sign in to comment.