Debugging Jekyll Sites

Debugging Jekyll Sites

How to debug your Jekyll site when you run into unknown errors

Jekyll Doctor

The Jekyll doctor command checks over the configuration file for any deprecation or configuration issues.

jekyll doctor
# or
jekyll hyde

Verbose Build

Build your Jekyll site with the verbose output option to see all build messages.

bundle exec jekyll build --verbose

Stack Trace

Build your Jekyll site with the trace option which is not listed as an option on the Jekyll build command options. This will show the stack trace of any errors that occur when building your Jekyll site.

jekyll build --trace

Gem Inspection

Sometimes you have to verify that a particular gem contains a file or folder expected by Jekyll or a Jekyll plugin. The following command allows you to peek at the gem file structure

ls $(bundle show [gem])