Skip to content

Latest commit

 

History

History
42 lines (27 loc) · 1.38 KB

README.md

File metadata and controls

42 lines (27 loc) · 1.38 KB
Raw

eleventy-upgrade-help v3.0

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

Previous versions:

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@3

Then, install this plugin:

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

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, UpgradeHelper should be listed 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.