Webricks currently not included by default in homebrew's ruby, leading to issues.

[AlDacMac]

Code of Conduct

• I have read and agree to the GitHub Docs project's Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll

What part(s) of the article would you like to see updated?

When following this article with ruby installed via homebrew, I I encountered the following error when trying to locally test my site: /Users/<user>/.gem/ruby/3.1.2/gems/jekyll-3.9.2/lib/jekyll/commands/serve/servlet.rb:3:in require': cannot load such file -- webrick (LoadError)`.

As discussed on this stackoverflow article, the issue is that webrick is not being included when homebrew is used to install Ruby 3.1.2: https://stackoverflow.com/questions/69890412/bundler-failed-to-load-command-jekyll.

I would suggest adding a line mentioning this, and telling the user to run bundle add webrick if they have used homebrew to install an affected version of ruby. Alternately, this specific error could be added to the troubleshooting jekyll errors section.

Additional information

No response

---

[maintainer edit]

Content plan here

[welcome]

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

[hegdepavankumar]

yeah good idea.

[cmwilson21]

@AlDacMac Thanks so much for opening an issue! I'll triage this for the team to take a look 👀

[isaacmbrown]

Hi @AlDacMac, thanks for opening this issue! ✨ This is clearly a problem that a lot of people have run into (e.g. github/pages-gem#752).

You or anyone else is welcome to open a PR to fix this. I'll include a very simple content plan below so it's easy for someone to identify the change.

Content plan

Running bundle exec jekyll serve to run your GitHub Page site locally can lead to an error if you're using a >3.0 version of Ruby, which doesn't come with webrick installed.

Audiences

Developers testing their Pages sites locally.

Documentation plan

In "Testing your GitHub Pages site locally with Jekyll," under the "Building your site locally" subsection, add a note under the codeblock in step 4 ({% note %} **Note:** ... {% endnote %}). Mention that:

• If you've installed Ruby 3.0 or later (which you may have if you installed the default version via homebrew), you might get an error at this step. That's because these versions of Ruby no longer come with webrick installed.
• To fix the error, try running bundle add webrick, then re-running bundle exec jekyll serve.

[dojutsu-user]

Hi @cmwilson21,
Taking this issue up.