dan
/
jekyll
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
jekyll/docs/_docs/configuration/options.md

5.1 KiB
Raw Permalink Blame History

title permalink
Configuration Options /docs/configuration/options/

The tables below list the available settings for Jekyll, and the various options (specified in the configuration file) and flags (specified on the command-line) that control them.

Global Configuration

{% for setting in site.data.config_options.global %} {% endfor %}
Setting Options and Flags

{{ setting.name }} {% if setting.version-badge %} {{ setting.version-badge }} {% endif %}

{{ setting.description }}

{{ setting.option }}

{% if setting.flag %}

{{ setting.flag }}

{% endif %}

Defaults

Set defaults for front matter variables.

see below
Destination folders are cleaned on site builds

The contents of <destination> are automatically cleaned, by default, when the site is built. Files or folders that are not created by your site will be removed. Some files could be retained by specifying them within the <keep_files> configuration directive.

Do not use an important location for <destination>; instead, use it as a staging area and copy files from there to your web server.

Build Command Options

{% for setting in site.data.config_options.build %} {% endfor %}
Setting Options and Flags

{{ setting.name }} {% if setting.version-badge %} {{ setting.version-badge }} {% endif %}

{{ setting.description }}

 {% if setting.option %}

{{ setting.option }}

{% endif %} {% if setting.flag %}

{{ setting.flag }}

{% endif %}

Serve Command Options

In addition to the options below, the serve sub-command can accept any of the options for the build sub-command, which are then applied to the site build which occurs right before your site is served.

{% for setting in site.data.config_options.serve %} {% endfor %}
Setting Options and Flags

{{ setting.name }} {% if setting.version-badge %} {{ setting.version-badge }} {% endif %}

{{ setting.description }}

 {% if setting.option %}

{{ setting.option }}

{% elsif setting.options %}

{% for option in setting.options %} {{ option }}
{% endfor %}

{% endif %} {% if setting.flag %}

{{ setting.flag }}

{% elsif setting.flags %}

{% for flag in setting.flags %} {{ flag }}
{% endfor %}

{% endif %}
Do not use tabs in configuration files

This will either lead to parsing errors, or Jekyll will revert to the default settings. Use spaces instead.