Major Version Upgrade Helper

• Source code on GitHub
• Sample project using the Upgrade Helper plugin

Usage

Step 1 Upgrade Eleventy

Upgrade your project’s version of Eleventy with npm before using this helper plugin.

# Upgrading from Eleventy v0 to v1
npm install @11ty/eleventy@1

# Or, upgrading from Eleventy v1 to v2
npm install @11ty/eleventy@2

# Or, upgrading from Eleventy v2 to v3
npm install @11ty/eleventy@3

Step 2 Install the Helper

Then, install the helper plugin. The major version will match the version of Eleventy that you’re upgrading to.

# Upgrading from Eleventy v0 to v1
npm install @11ty/eleventy-upgrade-help@1

# Or, upgrading from Eleventy v1 to v2
npm install @11ty/eleventy-upgrade-help@2

# Or, upgrading from Eleventy v2 to v3
npm install @11ty/eleventy-upgrade-help@3

Step 3 Add to Configuration File

Add to your configuration file (probably eleventy.config.js or .eleventy.js):

import UpgradeHelper from "@11ty/eleventy-upgrade-help";

export default function (eleventyConfig) {
	// If you have other `addPlugin` calls, it’s important that UpgradeHelper is added last.
	eleventyConfig.addPlugin(UpgradeHelper);
};

const UpgradeHelper = require("@11ty/eleventy-upgrade-help");

module.exports = function (eleventyConfig) {
	// If you have other `addPlugin` calls, it’s important that UpgradeHelper is added last.
	eleventyConfig.addPlugin(UpgradeHelper);
};

Step 4 Run your Build

Run your usual build command (e.g. npm run build) and pay attention to the output. Address any violations and warnings.

Step 5 Remove the plugin

Once you’ve removed all of the violations/warnings from your output, run npm uninstall @11ty/eleventy-upgrade-help to remove the plugin and delete the plugin code from your Eleventy configuration file.

Other pages in Plugins

• Create or use Plugins
• Image
• Fetch
• <is-land>
• Render
• Internationalization (i18n)
• RSS
• Upgrade Helper
• Syntax Highlighting
• InputPath to URL
• Navigation
• HTML <base>
• Bundle
• Id Attribute
• Community Plugins
• Retired Plugins