Use data file to render table at `/docs/configuration/options/#global-configuration` (#8377)
Merge pull request 8377
This commit is contained in:
Malathi
GitHub
parent
ae7115638a
commit
5924eb19f6
|
|
@ -0,0 +1,37 @@
|
|||
global:
|
||||
- name: Site Source
|
||||
description: Change the directory where Jekyll will read files
|
||||
option: "source: DIR"
|
||||
flag: -s, --source DIR
|
||||
- name: Site Destination
|
||||
description: Change the directory where Jekyll will write files
|
||||
option: "destination: DIR"
|
||||
flag: -d, --destination DIR
|
||||
- name: Safe
|
||||
description: "Disable <a href=\"/docs/plugins/\">non-whitelisted plugins</a>, caching to disk, and ignore symbolic links."
|
||||
option: "safe: BOOL"
|
||||
flag: --safe
|
||||
- name: Disable Disk Cache
|
||||
version-badge: 4.1.0
|
||||
description: "Disable caching of content to disk in order to skip creating a <code>.jekyll-cache</code> or similar directory at the source to avoid interference with virtual environments and third-party directory watchers. Caching to disk is always disabled in <code>safe</code> mode."
|
||||
option: "disable_disk_cache: BOOL"
|
||||
flag: --disable-disk-cache
|
||||
- name: Ignore theme configuration
|
||||
version-badge: 4.1.0
|
||||
description: "Jekyll 4.0 started allowing themes to bundle a <code>_config.yml</code> to simplify theme-onboarding for new users. In the unfortunate situation that importing a bundled theme configuration messes up the merged site-configuration, the user can configure Jekyll to not import the theme-config entirely."
|
||||
option: "ignore_theme_config: BOOL"
|
||||
- name: Exclude
|
||||
description: "Exclude directories and/or files from the conversion. These exclusions are relative to the site's source directory and cannot be outside the source directory."
|
||||
option: "exclude: [DIR, FILE, ...]"
|
||||
- name: Include
|
||||
description: "Force inclusion of directories and/or files in the conversion. <code>.htaccess</code> is a good example since dotfiles are excluded by default."
|
||||
option: "include: [DIR, FILE, ...]"
|
||||
- name: Keep files
|
||||
description: "When clobbering the site destination, keep the selected files. Useful for files that are not generated by jekyll; e.g. files or assets that are generated by your build tool. The paths are relative to the <code>destination</code>."
|
||||
option: "keep_files: [DIR, FILE, ...]"
|
||||
- name: Time Zone
|
||||
description: "Set the time zone for site generation. This sets the <code>TZ</code> environment variable, which Ruby uses to handle time and date creation and manipulation. Any entry from the <a href=\"https://en.wikipedia.org/wiki/Tz_database\">IANA Time Zone Database</a> is valid, e.g. <code>America/New_York</code>. A list of all available values can be found <a href=\"https://en.wikipedia.org/wiki/List_of_tz_database_time_zones\"> here</a>. When serving on a local machine, the default time zone is set by your operating system. But when served on a remote host/server, the default time zone depends on the server's setting or location."
|
||||
option: "timezone: TIMEZONE"
|
||||
- name: Encoding
|
||||
description: "Set the encoding of files by name (only available for Ruby 1.9 or later). The default value is <code>utf-8</code> starting in 2.0.0, and <code>nil</code> before 2.0.0, which will yield the Ruby default of <code>ASCII-8BIT</code>. Available encodings can be shown by the command <code>ruby -e 'puts Encoding::list.join(\"\\n\")'</code>."
|
||||
option: "encoding: ENCODING"
|
||||
|
|
@ -20,150 +20,25 @@ class="flag">flags</code> (specified on the command-line) that control them.
|
|||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="setting">
|
||||
<td>
|
||||
<p class="name"><strong>Site Source</strong></p>
|
||||
<p class="description">Change the directory where Jekyll will read files</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
<p><code class="option">source: DIR</code></p>
|
||||
<p><code class="flag">-s, --source DIR</code></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="setting">
|
||||
<td>
|
||||
<p class="name"><strong>Site Destination</strong></p>
|
||||
<p class="description">Change the directory where Jekyll will write files</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
<p><code class="option">destination: DIR</code></p>
|
||||
<p><code class="flag">-d, --destination DIR</code></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="setting">
|
||||
<td>
|
||||
<p class="name"><strong>Safe</strong></p>
|
||||
<p class="description">
|
||||
Disable <a href="/docs/plugins/">non-whitelisted plugins</a>, caching to disk,
|
||||
and ignore symbolic links.
|
||||
</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
<p><code class="option">safe: BOOL</code></p>
|
||||
<p><code class="flag">--safe</code></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="setting">
|
||||
<td>
|
||||
<p class="name">
|
||||
<strong>Disable Disk Cache</strong>
|
||||
<span class="version-badge" title="Introduced in v4.1.0">4.1.0</span>
|
||||
</p>
|
||||
<p class="description">
|
||||
Disable caching of content to disk in order to skip creating a
|
||||
<code>.jekyll-cache</code> or similar directory at the source
|
||||
to avoid interference with virtual environments and third-party
|
||||
directory watchers.
|
||||
Caching to disk is always disabled in <code>safe</code> mode.
|
||||
</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
<p><code class="option">disable_disk_cache: BOOL</code></p>
|
||||
<p><code class="flag">--disable-disk-cache</code></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="setting">
|
||||
<td>
|
||||
<p class="name">
|
||||
<strong>Ignore theme configuration</strong>
|
||||
<span class="version-badge" title="Introduced in v4.1.0">4.1.0</span>
|
||||
</p>
|
||||
<p class="description">
|
||||
Jekyll 4.0 started allowing themes to bundle a <code>_config.yml</code>
|
||||
to simplify theme-onboarding for new users.
|
||||
In the unfortunate situation that importing a bundled theme configuration
|
||||
messes up the merged site-configuration, the user can configure Jekyll
|
||||
to not import the theme-config entirely.
|
||||
</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
<p><code class="option">ignore_theme_config: BOOL</code></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="setting">
|
||||
<td>
|
||||
<p class="name"><strong>Exclude</strong></p>
|
||||
<p class="description">
|
||||
Exclude directories and/or files from the
|
||||
conversion. These exclusions are relative to the site's
|
||||
source directory and cannot be outside the source directory.
|
||||
</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
<p><code class="option">exclude: [DIR, FILE, ...]</code></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="setting">
|
||||
<td>
|
||||
<p class="name"><strong>Include</strong></p>
|
||||
<p class="description">
|
||||
Force inclusion of directories and/or files in the conversion.
|
||||
<code>.htaccess</code> is a good example since dotfiles are excluded
|
||||
by default.
|
||||
</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
<p><code class="option">include: [DIR, FILE, ...]</code></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="setting">
|
||||
<td>
|
||||
<p class="name"><strong>Keep files</strong></p>
|
||||
<p class="description">
|
||||
When clobbering the site destination, keep the selected files.
|
||||
Useful for files that are not generated by jekyll; e.g. files or
|
||||
assets that are generated by your build tool.
|
||||
The paths are relative to the <code>destination</code>.
|
||||
</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
<p><code class="option">keep_files: [DIR, FILE, ...]</code></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="setting">
|
||||
<td>
|
||||
<p class="name"><strong>Time Zone</strong></p>
|
||||
<p class="description">
|
||||
Set the time zone for site generation. This sets the <code>TZ</code>
|
||||
environment variable, which Ruby uses to handle time and date
|
||||
creation and manipulation. Any entry from the
|
||||
<a href="https://en.wikipedia.org/wiki/Tz_database">IANA Time Zone
|
||||
Database</a> is valid, e.g. <code>America/New_York</code>. A list of all
|
||||
available values can be found <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">
|
||||
here</a>. When serving on a local machine, the default time zone is set by your operating system. But when served on a remote host/server, the default time zone depends on the server's setting or location.
|
||||
</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
<p><code class="option">timezone: TIMEZONE</code></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="setting">
|
||||
<td>
|
||||
<p class="name"><strong>Encoding</strong></p>
|
||||
<p class="description">
|
||||
Set the encoding of files by name (only available for Ruby
|
||||
1.9 or later).
|
||||
The default value is <code>utf-8</code> starting in 2.0.0,
|
||||
and <code>nil</code> before 2.0.0, which will yield the Ruby
|
||||
default of <code>ASCII-8BIT</code>.
|
||||
Available encodings can be shown by the
|
||||
command <code>ruby -e 'puts Encoding::list.join("\n")'</code>.
|
||||
</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
<p><code class="option">encoding: ENCODING</code></p>
|
||||
</td>
|
||||
</tr>
|
||||
{% for setting in site.data.config_options.global %}
|
||||
<tr class="setting">
|
||||
<td>
|
||||
<p class="name">
|
||||
<strong>{{ setting.name }}</strong>
|
||||
{% if setting.version-badge %}
|
||||
<span class="version-badge" title="Introduced in v{{ setting.version-badge }}">{{ setting.version-badge }}</span>
|
||||
{% endif %}
|
||||
</p>
|
||||
<p class="description">{{ setting.description }}</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
<p><code class="option">{{ setting.option }}</code></p>
|
||||
{% if setting.flag %}
|
||||
<p><code class="flag">{{ setting.flag }}</code></p>
|
||||
{% endif %}
|
||||
</td>
|
||||
</tr>
|
||||
{% endfor %}
|
||||
<tr>
|
||||
<td>
|
||||
<p class='name'><strong>Defaults</strong></p>
|
||||
|
|
|
|||
Loading…
Reference in New Issue