Skip to content

Commit f1fef94

Browse files
committed
Adds context for docs
Added mentions of Essential Next.js plugin for users coming to these docs pages from links outside this repo.
1 parent b5a2f27 commit f1fef94

7 files changed

+8
-7
lines changed

Diff for: docs/caveats.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Versions
44

5-
You can check our `package.json` for supported Node versions.
5+
You can check the Essential Next.js plugin's `package.json` for supported Node versions.
66

77
For breaking Next.js releases, all Next.js versions before the breaking release will be locked to the last working plugin version:
88

Diff for: docs/cli-usage.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## CLI Usage
22

3-
If you'd like to build and deploy your project using the [Netlify CLI](https://docs.netlify.com/cli/get-started/), we recommend this workflow to manage git tracking plugin-generated files:
3+
If you'd like to build and deploy your project using the [Netlify CLI](https://docs.netlify.com/cli/get-started/), we recommend this workflow to manage git tracking for files generated by the Essential Next.js plugin:
44

55
1. Make sure all your project's files are committed before running a build with the CLI
66
2. Run any number of builds and deploys freely (i.e. `netlify build`, `netlify deploy --build`, `netlify deploy --prod`)

Diff for: docs/custom-functions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Custom Netlify Functions
22

3-
This plugin creates one Netlify Function for each Next.js page that requires one.
3+
This Essential Next.js plugin creates one Netlify Function for each Next.js page that requires one.
44
To use custom Netlify Functions in addition to what the plugin generates, add a path to your functions folder in `netlify.toml`:
55

66
```toml

Diff for: docs/custom-redirects.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
## Custom Netlify Redirects
22

3-
You can define custom redirects in a `_redirects` file.
3+
You can define custom redirects in a `_redirects` file for apps using the Essential Next.js plugin.
4+
45
The precedence of these rules are:
56

67
- `_redirects`

Diff for: docs/faq.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## FAQ
22

3-
**Q: What can I do if my builds fail suddenly from a broken plugin release or plugin dependency?**
3+
**Q: What can I do if my builds fail suddenly from a broken Essential Next.js plugin release or plugin dependency?**
44

55
A: Check out the plugin's [releases](https://github.com/netlify/netlify-plugin-nextjs/releases). You can manually install `npm install --save @netlify/[email protected]` at the last working version.
66
Once a new working release is out, you can uninstall the plugin at this locked version (`npm uninstall --save @netlify/plugin-nextjs`), which will re-enable Netlify's build system to use the latest plugin version by default.

Diff for: docs/image-handling.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Image Handling
22

3-
The plugin includes a function to generate images for `next/image`. The images are resized on the fly, so the first request will have a short delay. However because the function uses [On-Demand Builders](https://docs.netlify.com/configure-builds/on-demand-builders/), any subsequent requests for that image are served from the edge cache and are super-fast.
3+
The Essential Next.js plugin includes a function to generate images for `next/image`. The images are resized on the fly, so the first request will have a short delay. However because the function uses [On-Demand Builders](https://docs.netlify.com/configure-builds/on-demand-builders/), any subsequent requests for that image are served from the edge cache and are super-fast.
44

55
By default, images are returned in the same format as the source image if they are in JPEG, PNG, WebP or AVIF format. If you are only targeting modern browsers and want to live life on the edge, you can [set the environment variable](https://docs.netlify.com/configure-builds/environment-variables/) `FORCE_WEBP_OUTPUT` to `"true"`, and it will return all images in WebP format. This will often lead to significant improvements in file size. However you should not use this if you need to support older browsers, as `next/image` does not support picture tag source fallback and images will appear broken. Check [browser support](https://caniuse.com/webp) to see if you are happy to do this.
66

Diff for: docs/local-files-in-runtime.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
A common requirement for Next.js projects is to require local files in Next.js pages (see [markdown issue](https://github.com/netlify/netlify-plugin-nextjs/issues/153) and [i18next issue](https://github.com/netlify/netlify-plugin-nextjs/issues/223) as examples).
44

5-
In this case, you can configure your netlify.toml to make sure these files are included in the function runtime environment. This is necessary for pages that use fallback: true, SSR, preview mode, etc. For example:
5+
When using the Essential Next.js plugin, you can configure your `netlify.toml` to make sure these files are included in the function runtime environment. This is necessary for pages that use fallback: true, SSR, preview mode, etc. For example:
66

77
```toml
88
[build]

0 commit comments

Comments
 (0)