Table of contents

Resources
Roge Syntax Highlighter used by Jekyll
Jekyll Commands
CLI
YML Config
Metadata

Resources

Setup

Configuration

GitHubActions

Jekyll Docker Image

FrontMatter Defaults

Markdown Processor

Kramdown

QuickRef

Kramdown markdown cheat sheet

Rouge - Jekyll’s Default Highlighter

GitHub

Jekyll Docs For Code snippet highlighting

GFM(GitHub Flavored Markdown)

Jekyll GitHub metadata Configuration

Roge Syntax Highlighter used by Jekyll

Docs

List Of Supported Languages and Lexers

Rouge Language Lexers GitHub Repo

Rouge Syntax Highlighting Languages

Jekyll Commands

CLI

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

Resources

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

YML Config

Where things are

source:          .
destination:     ./_site
collections_dir: .
plugins_dir:     _plugins # takes an array of strings and loads plugins in that order
layouts_dir:     _layouts
data_dir:        _data
includes_dir:    _includes
sass:
sass_dir:        _sass
collections:
posts:
output:          true

Handling Reading

safe:                false
include: [ ".htaccess" ]
exclude: [ "Gemfile",
           "Gemfile.lock",
           "node_modules",
           "vendor/bundle/",
           "vendor/cache/",
           "vendor/gems/",
           "vendor/ruby/", ]
keep_files: [ ".git", ".svn" ]
encoding:            "utf-8"
markdown_ext:        "markdown,mkdown,mkdn,mkd,md"
strict_front_matter: false

Filtering Content

show_drafts: null
limit_posts: 0
future:      false
unpublished: false

Plugins

whitelist: [ ]
plugins: [ ]

Conversion

markdown:          kramdown
highlighter:       rouge
lsi:               false
excerpt_separator: "\n\n"
incremental:       false

Serving

detach:           false
port:             4000
host:             127.0.0.1
baseurl:          "" # does not include hostname
show_dir_listing: false

Outputting

permalink:        date
paginate_path:    /page:num
timezone:         null

quiet:            false
verbose:          false
defaults: [ ]

liquid:
error_mode:       warn
strict_filters:   false
strict_variables: false

Markdown Processors

Options

kramdown:
auto_ids:      true
entity_output: as_char
toc_levels: [ 1, 2, 3, 4, 5, 6 ]
smart_quotes:  lsquo,rsquo,ldquo,rdquo
input:         GFM
hard_wrap:     false
footnote_nr:   1
show_warnings: false

Metadata

{
  "versions": {
    "jekyll": "<version>",
    "kramdown": "<version>",
    "liquid": "<version>",
    "maruku": "<version>",
    "rdiscount": "<version>",
    "redcarpet": "<version>",
    "RedCloth": "<version>",
    "jemoji": "<version>",
    "jekyll-mentions": "<version>",
    "jekyll-redirect-from": "<version>",
    "jekyll-sitemap": "<version>",
    "github-pages": "<version>",
    "ruby": "<version>"
  },
  "hostname": "github.com",
  "pages_hostname": "github.io",
  "api_url": "https://api.github.com",
  "help_url": "https://help.github.com",
  "environment": "dotcom",
  "pages_env": "dotcom",
  "public_repositories": [
    " Repository Objects"
  ],
  "organization_members": [
    "User Objects"
  ],
  "build_revision": "cbd866ebf142088896cbe71422b949de7f864bce",
  "project_title": "metadata-example",
  "project_tagline": "A GitHub Pages site to showcase repository metadata",
  "owner_name": "github",
  "owner_url": "https://github.com/github",
  "owner_gravatar_url": "https://github.com/github.png",
  "repository_url": "https://github.com/github/metadata-example",
  "repository_nwo": "github/metadata-example",
  "repository_name": "metadata-example",
  "zip_url": "https://github.com/github/metadata-example/zipball/gh-pages",
  "tar_url": "https://github.com/github/metadata-example/tarball/gh-pages",
  "clone_url": "https://github.com/github/metadata-example.git",
  "releases_url": "https://github.com/github/metadata-example/releases",
  "issues_url": "https://github.com/github/metadata-example/issues",
  "wiki_url": "https://github.com/github/metadata-example/wiki",
  "language": null,
  "is_user_page": false,
  "is_project_page": true,
  "show_downloads": true,
  "url": "http://username.github.io/metadata-example ||   (or the CNAME)",
  "baseurl": "/metadata-example",
  "contributors": [
    "User Objects"
  ],
  "releases": [
    "Release Objects"
  ],
  "latest_release": [
    "Release Object"
  ],
  "private": false,
  "archived": false,
  "disabled": false,
  "license": {
    "key": "mit",
    "name": "MIT License",
    "spdx_id": "MIT",
    "url": "https://api.github.com/licenses/mit"
  },
  "source": {
    "branch": "gh-pages",
    "path": "/"
  }
}