$ github-pages health-check Checking domain foo.invalid.

Note: the github-pages function may be enabled by sourcing func.sh. github-pages from the directory of the Jekyll site to be previewed when func.sh has been sourced into your terminal session.github-pages $PATH_TO_YOUR_PROJECT from any directory when func.sh has been sourced into your terminal session or.SITE=PATH_TO_YOUR_PROJECT docker run -rm -p 4000:4000 -v `realpath $`:/src/site gh-pages from any directory or.SITE=PATH_TO_YOUR_PROJECT make server from the root of the gh-pages repository (where the Makefile resides) or.Start an instance of the server by running either:.Alternatively use make image_alpine for a smaller alpine-based image.Run make image from the root of the pages-gem directory to build an image which will be tagged as gh-pages.

Provided that Docker is installed, one may avoid the setup of additional tools within the environment by simply spawning a Docker container. For more information about installing Jekyll locally, please see the GitHub Help docs on the matter. Once the github-pages gem is installed, you can build your site using jekyll build, or preview your site using jekyll serve.

Note: You are not required to install Jekyll separately. Gem 'github-pages', group: :jekyll_plugins

Gem install jekyll on windows