Sandbox Jekyll documentation

Configuration Guide

Detailed breakdown of the Sandbox Jekyll theme's configuration file

General Site & Build Settings

Site Settings

# Site Settings
baseurl: ""
url: ""

Build Settings

# Build settings
markdown: kramdown
permalink: /blog/:title/
sass:
  style: compressed
  sass_dir: _sass
  sourcemap: never

Plugins

# Plugins
plugins:
  - jekyll-feed
  - jekyll-seo-tag
  - jekyll-sitemap
  - jekyll-paginate-v2
  - jekyll-watch
  - jekyll-toc

TOC Settings

# TOC Settings for documentation
toc:
  min_level: 2
  max_level: 3
  ordered: false
  numbered_items: true
  auto_ids: true
  sanitize: false

Content & Functionality Settings

Pagination

# Pagination
pagination:
  enabled: true
  collections:
    - name: 'posts'
      per_page: 6
      permalink: '/blog/page:num/'

Collections

# Collections
collections:
  projects:
    output: true
    permalink: /projects/:path/
  authors:
    output: true
    permalink: /authors/:path/

LiveReload

# LiveReload settings
livereload_max_delay: 5
livereload_min_delay: 2.5