From eb66a8843f1e27d47a350e37ace508e583ebdd35 Mon Sep 17 00:00:00 2001 From: rstavchansky Date: Mon, 7 Dec 2020 11:56:24 -0600 Subject: [PATCH 1/3] Edits to installation process --- README.md | 36 +++++++++++++++++++++++------------- 1 file changed, 23 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index b586b4aafa..6110bd452b 100644 --- a/README.md +++ b/README.md @@ -25,27 +25,37 @@ This build plugin is a utility for supporting Next.js on Netlify. To enable serv ## Installation and Configuration -There are two ways to install the plugin in your Next.js on Netlify site. +There are two ways to install the plugin in your Next.js on Netlify site: with the Netlify UI or with file-based installation. -**Option 1: UI-based Installation** +**UI-based Installation** -This plugin can be installed and managed from your site's settings on Netlify. - -[👉 Click to install this plugin 👈](http://app.netlify.com/plugins/@netlify/plugin-nextjs/install) +You can install this plugin using this [direct in-app installation link](http://app.netlify.com/plugins/@netlify/plugin-nextjs/install) or from your team's [Plugins directory](https://app.netlify.com/plugins) in the Netlify UI. Read more about [UI-based plugin installation](https://docs.netlify.com/configure-builds/build-plugins/#ui-installation) in our docs. -**Option 2: File-based Installation** +**File-based Installation** -Create a `netlify.toml` in the root of your project. Your file should include the plugins section below: +1. Create a `netlify.toml` in the root of your project. Your file should include the plugins section below: -```toml -[build] - command = "npm run build" + ```toml + [build] + command = "npm run build" + + [[plugins]] + package = "@netlify/plugin-nextjs" + ``` -[[plugins]] - package = "@netlify/plugin-nextjs" -``` +2. From your project's base directory, use `npm`, `yarn`, or any other Node.js package manager to add this plugin to `package.json` as a dependency. + + ``` + npm install -D @netlify/plugin-nextjs + ``` + + or + + ``` + yarn add -D @netlify/plugin-nextjs + ``` Read more about [file-based plugin installation](https://docs.netlify.com/configure-builds/build-plugins/#file-based-installation) in our docs. From 9bfc2c01ff3e0853bbee50e24aea69de4751367d Mon Sep 17 00:00:00 2001 From: rstavchansky Date: Mon, 7 Dec 2020 11:56:24 -0600 Subject: [PATCH 2/3] Edits to installation process --- README.md | 36 +++++++++++++++++++++++------------- 1 file changed, 23 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index b586b4aafa..6110bd452b 100644 --- a/README.md +++ b/README.md @@ -25,27 +25,37 @@ This build plugin is a utility for supporting Next.js on Netlify. To enable serv ## Installation and Configuration -There are two ways to install the plugin in your Next.js on Netlify site. +There are two ways to install the plugin in your Next.js on Netlify site: with the Netlify UI or with file-based installation. -**Option 1: UI-based Installation** +**UI-based Installation** -This plugin can be installed and managed from your site's settings on Netlify. - -[👉 Click to install this plugin 👈](http://app.netlify.com/plugins/@netlify/plugin-nextjs/install) +You can install this plugin using this [direct in-app installation link](http://app.netlify.com/plugins/@netlify/plugin-nextjs/install) or from your team's [Plugins directory](https://app.netlify.com/plugins) in the Netlify UI. Read more about [UI-based plugin installation](https://docs.netlify.com/configure-builds/build-plugins/#ui-installation) in our docs. -**Option 2: File-based Installation** +**File-based Installation** -Create a `netlify.toml` in the root of your project. Your file should include the plugins section below: +1. Create a `netlify.toml` in the root of your project. Your file should include the plugins section below: -```toml -[build] - command = "npm run build" + ```toml + [build] + command = "npm run build" + + [[plugins]] + package = "@netlify/plugin-nextjs" + ``` -[[plugins]] - package = "@netlify/plugin-nextjs" -``` +2. From your project's base directory, use `npm`, `yarn`, or any other Node.js package manager to add this plugin to `package.json` as a dependency. + + ``` + npm install -D @netlify/plugin-nextjs + ``` + + or + + ``` + yarn add -D @netlify/plugin-nextjs + ``` Read more about [file-based plugin installation](https://docs.netlify.com/configure-builds/build-plugins/#file-based-installation) in our docs. From cc1b28270cc68da84a970cb940081322a6e5d2e5 Mon Sep 17 00:00:00 2001 From: rstavchansky Date: Mon, 7 Dec 2020 13:18:19 -0600 Subject: [PATCH 3/3] devDependencies is more specific --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6110bd452b..2014f1219f 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ Read more about [UI-based plugin installation](https://docs.netlify.com/configur package = "@netlify/plugin-nextjs" ``` -2. From your project's base directory, use `npm`, `yarn`, or any other Node.js package manager to add this plugin to `package.json` as a dependency. +2. From your project's base directory, use `npm`, `yarn`, or any other Node.js package manager to add this plugin to `devDependencies` in `package.json`. ``` npm install -D @netlify/plugin-nextjs