Running Jekyll (the engine that powers GitHub Pages) locally can be a big help when you’d like to preview a site on your computer before pushing changes, or if you are trying to diagnose a troubled build.
Starting today, you can bootstrap an environment that mirrors the GitHub Pages servers as closely as possible by simply running the command
gem install github-pages from your project’s directory.
Or if you’ve got Bundler installed, simply add
gem 'github-pages' to a file named
Gemfile in the project’s root directory, then run the
bundle install command.
Better yet, we’re using the Gem here at GitHub, so as our servers update, you can more easily update your local environment, ensuring what you see on your computer matches what others see once the site is published. Just run
gem update github-pages or
bundle update github-pages and everything will be .
You can begin adding the Gem to your sites immediately, or for more information see the Using Jekyll with Pages help article.