jekyll-commands.md

Jekyll Commands

Jekyll is a simple, blog-aware, static site generator.

Resources

• Jekyll official site
• Build A Blog With Jekyll And GitHub Pages

Requirements

Install Ruby on your machine.

Installing Jekyll

$ gem install jekyll

Quickstart:

$ jekyll new my-site
$ cd my-site
$ jekyll build
$ jekyll serve    # => Browse your site @ http://localhost:4000

Setting up your GitHub Pages site locally with Jekyll

Install Bundler:

$ gem install bundler

Specify your dependencies in a Gemfile in your project's root:

source 'https://rubygems.org'

gem 'github-pages'

Install all of the required gems from your specified sources:

$ bundle install

Other Bundler commands

$ bundle install --without [<group name> [<group name ...]] - install dependencies without specified group in a Gemfile

$ bundle clean - delete outdated dependencies plus which are not in Gemfile

$ bundle clean --force - force to delete dependencies

Jekyll basic usage with Bundler

Build site using default _config.yml file:

$ bundle exec jekyll clean or $ rm -rf _site- Deletes Jekyll generated old ./_site cache folder

$ bundle exec jekyll build - Build site will be generated into ./_site

$ JEKYLL_ENV=production bundle exec jekyll build - Build site as production, default is development

$ bundle exec jekyll build --watch - Build site into ./_site and for watch changes

$ bundle exec jekyll serve - Serve site at http://localhost:4000

Override config (_config_dev.yml) for local development test:

$ bundle exec jekyll build --config _config.yml,_config_dev.yml - Build site

$ bundle exec jekyll build --config _config.yml,_config_dev.yml --watch - Build site and watch changes

$ bundle exec jekyll serve --config _config.yml,_config_dev.yml - Serve site at http://localhost:4000

$ JEKYLL_GITHUB_TOKEN=abc123def456 [bundle exec] jekyll serve - Serve site authenticating GitHub for github-metadata