- Stable
3.0.0
- Canary
3.0.1-alpha.3
Toggle Menu
Eleventy
1.93s
Astro
22.90s
Major Version Upgrade Helper
Contents
Usage
Jump to section titled: UsageStep 1 Upgrade Eleventy
Jump to section titled: Step 1 Upgrade EleventyUpgrade 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
Jump to section titled: Step 2 Install the HelperThen, 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
Jump to section titled: Step 3 Add to Configuration FileAdd to your configuration file (probably eleventy.config.js
or .eleventy.js
):
eleventy.config.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
Jump to section titled: Step 4 Run your BuildRun 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
Jump to section titled: Step 5 Remove the pluginOnce 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.