https://github.com/11ty/eleventy-upgrade-help

Helper plugin when upgrading your Eleventy project to a new major version.
https://github.com/11ty/eleventy-upgrade-help

eleventy eleventy-plugin

Last synced: 10 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/11ty/eleventy-upgrade-help
• Owner: 11ty
• Created: 2021-07-09T13:48:49.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-08-01T16:46:59.000Z (6 months ago)
• Last Synced: 2024-10-29T15:44:50.434Z (3 months ago)
• Topics: eleventy, eleventy-plugin
• Language: JavaScript
• Size: 58.6 KB
• Stars: 68
• Watchers: 8
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# eleventy-upgrade-help v3.0

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

Previous versions:

* [Upgrade from 0.x to 1.0](https://github.com/11ty/eleventy-upgrade-help/tree/v1.x)

* [Upgrade from 1.x to 2.0](https://github.com/11ty/eleventy-upgrade-help/tree/v2.x)

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:

```bash

npm install @11ty/eleventy@3

```

Then, install this plugin:

```bash

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

```

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

```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](https://github.com/11ty/demo-eleventy-upgrade-help).