11ty / eleventy-upgrade-help

Helper plugin when upgrading your Eleventy project to a new major version.

eleventy-upgrade-help v2.0

A plugin to help you upgrade your Eleventy project from Eleventy v1.0 to v2.0.

Previous versions:

• Upgrade from 0.12 to 1.0

The major version of this plugin will always match the major version of Eleventy that you’re upgrading to.

Usage

Upgrade Eleventy with npm before using this plugin by running the following command:

npm install @11ty/eleventy@2

Then, install this plugin:

npm install @11ty/eleventy-upgrade-help@2

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

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);
};

Run your usual build command (e.g. npm run build) and pay attention to the output. Address any violations and warnings. 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 its code from your Eleventy configuration file.

Example demo

You can review a sample project using this upgrade plugin.