Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify instructions #6

Merged
merged 1 commit into from
Feb 14, 2023
Merged

Clarify instructions #6

merged 1 commit into from
Feb 14, 2023

Conversation

LeaVerou
Copy link
Contributor

  • Made it clear that Eleventy needs to be upgraded before running this plugin. That was not clear to me at first, I thought the plugin itself would upgrade it, or it would tell me if it's safe to upgrade.
  • Added instructions on how to get output from this plugin (running the usual build command), and clarified when exactly to remove it
  • Removing the plugin from package.json doesn't remove it from node_modules, whereas npm uninstall does.

- Made it clear that Eleventy needs to be upgraded **before** running this plugin. That was not clear to me at first, I thought the plugin itself would upgrade it, or it would tell me if it's safe to upgrade.
- Added instructions on how to get output from this plugin (running the usual build command), and clarified when exactly to remove it
@SHiLLySiT
Copy link

I went looking thru issues/PRs specifically for the second bullet point as I assumed there was going to be a second command to run, so this was very helpful!

Also, if anyone is using Github Actions to deploy sites, you may need to bump your Node version in your Github Actions main.yml as eleventy now requires Node 14+.

@zachleat zachleat merged commit ad4882c into 11ty:main Feb 14, 2023
@zachleat
Copy link
Member

Thank you for this! I may tweak it a bit as we discourage folks to globally install eleventy now but it’s great! https://www.11ty.dev/docs/global-installation/

zachleat added a commit that referenced this pull request Feb 14, 2023
@LeaVerou
Copy link
Contributor Author

I may tweak it a bit as we discourage folks to globally install eleventy now but it’s great! 11ty.dev/docs/global-installation

Great! Global installation is a huge footgun, glad to see it's discouraged now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants