dan
/
jekyll
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document Exclude behavior, Include overrides and the default exclusion list (#9376) 

Merge pull request 9376
This commit is contained in:
Tomáš Hübelbauer 2023-06-05 14:45:31 +02:00 committed by GitHub
parent 58a1f62b23
commit 11987c65e0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/_data/config_options/global.yml
View File

@ -40,13 +40,33 @@
description: >- description: >-
Exclude directories and/or files from the conversion. These exclusions are relative to the site's source directory 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. and cannot be outside the source directory.
<br />
In Jekyll 3, the `exclude` configuration option replaces the default exclusion list.
<br />
In Jekyll 4, user-provided entries get added to the default exclusion list instead and the `include` option can be
used to override the default exclusion list entries.
<br />
The default exclusions are found in <code>_config.yml</code> as created by <code>jekyll new</code>:
<ul>
<li><code>.sass-cache/</code></li>
<li><code>.jekyll-cache/</code></li>
<li><code>gemfiles/</code></li>
<li><code>Gemfile</code></li>
<li><code>Gemfile.lock</code></li>
<li><code>node_modules/</code></li>
<li><code>vendor/bundle/</code></li>
<li><code>vendor/cache/</code></li>
<li><code>vendor/gems/</code></li>
<li><code>vendor/ruby/</code></li>
</ul>
option: "exclude: [DIR, FILE, ...]" option: "exclude: [DIR, FILE, ...]"
- name: Include - name: Include
description: >- description: >-
Force inclusion of directories and/or files in the conversion. <code>.htaccess</code> is a good example since Force inclusion of directories and/or files in the conversion. <code>.htaccess</code> is a good example since
dotfiles are excluded by default. dotfiles are excluded by default. With Jekyll 4, the `include` configuration option entries override the
`exclude` option entries.
option: "include: [DIR, FILE, ...]" option: "include: [DIR, FILE, ...]"