Configuration

Jigyll reads its settings from a _config.yml file in your site's root directory, exactly like Jekyll. Options can also be set with command-line flags, which take precedence over the config file.

Differs from Jekyll. Only _config.yml is read — there is no _config.toml support. And Jigyll is strict about types: a wrong YAML type for a supported key (a list where a string is expected, or vice versa) is a build error, where Jekyll often coerces or ignores it. Unknown keys are fine — they simply become site.* variables.

Multiple config files

Pass a comma-separated list to --config; later files override earlier ones:

jigyll build --config _config.yml,_config.production.yml

The JEKYLL_CONFIG environment variable is used as the file list when --config is not given.

Default configuration

Jigyll's defaults, which your _config.yml overrides:

# Where things are
source:       .
destination:  ./_site
layouts_dir:  _layouts
data_dir:     _data
includes_dir: _includes
collections:
  posts:
    output:   true

# Handling Reading
include:              [".htaccess"]
exclude:              ["Gemfile", "Gemfile.lock", "node_modules", "vendor/bundle/", "vendor/cache/", "vendor/gems/", "vendor/ruby/"]
keep_files:           [".git", ".svn"]
markdown_ext:         "markdown,mkdown,mkdn,mkd,md"

# Plugins
plugins:   []

# Conversion
excerpt_separator: "\n\n"
incremental: false

# Serving
port:    4000
host:    127.0.0.1
baseurl: "" # does not include hostname

# Outputting
permalink: date
timezone:  null

verbose: false
sass:
  sass_dir: _sass

Other supported keys: theme, url, show_drafts, future, unpublished, defaults (see below). permalink accepts the date, pretty, ordinal, and none styles or a custom template string.

Front matter defaults

The defaults key works like Jekyll's — an array of scope/values pairs:

defaults:
  - scope:
      path: ""        # empty string matches all files
      type: "posts"   # optional: pages, posts, drafts, or a collection name
    values:
      layout: "default"

Front matter in the file itself always wins. Beyond that, conflicts between matching scopes are resolved by precedence, as in Jekyll:

1. The scope with the longer path wins, regardless of config order.
2. On equal-length paths, a scope with a type beats one without.
3. On a final tie, the later entry in defaults wins.

Matching scopes contribute their values by merging (different keys coexist; overlapping keys are decided by the precedence rules above).

path may contain globs using * and **:

defaults:
  - scope: { path: "assets/**" }
    values: { sitemap: false, image: true }
  - scope: { path: "section/*/special.md" }
    values: { layout: special }

* matches a single path segment (it does not cross /); ** matches any number of segments. As in Jekyll, a glob scope also matches any file under a directory the glob expands to, so section/* applies to section/a/deep/f.md (via the section/a directory).

type filters which documents a scope applies to. A scope without type matches every document, including static files (files without front matter). A scope with type matches only documents of that type; static files outside any collection are untyped, so a type: pages scope does not apply to them (e.g. scope: { type: pages } values: { published: false } will not drop static files). Static files inside a collection have that collection's name as their type.

See also Static Files for surfacing default values on static files via site.static_files.

Environments

The JEKYLL_ENV environment variable is exposed to Liquid as jekyll.environment, defaulting to development:

JEKYLL_ENV=production jigyll build

{% if jekyll.environment == "production" %}
  {% include analytics.html %}
{% endif %}

Jigyll also honors JEKYLL_URL, which overrides the configured url.

Markdown and Liquid options

Differs from Jekyll. Jekyll's markdown:, kramdown:, and liquid: configuration sections are ignored. Jigyll has a single built-in goldmark renderer that is not configurable, and Liquid error handling is fixed: undefined filters and tags are build errors, undefined variables render as empty. error_mode, strict_variables, and strict_filters have no effect.

Sass options

Sass/SCSS conversion is always on (see jekyll-sass-converter). Of Jekyll's sass: options, only sass_dir is honored:

sass:
  sass_dir: _sass   # the default

Differs from Jekyll. Output is always minified — style is ignored. Conversion requires the Dart Sass sass executable on your PATH. Compiled CSS is cached in /tmp/jigyll-$USER, not ./.sass-cache.

Incremental regeneration

As in Jekyll, pass --incremental (-I) or set incremental: true to only regenerate documents whose sources (or included templates/layouts) changed.

Unsupported keys

safe, whitelist, highlighter, lsi, limit_posts, and profile have no effect. Plugins are configured with plugins: (the legacy gems: alias also works) — never a Gemfile.