Skip to content

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

Merged
jekyllbot merged 5 commits intojekyll:masterfrom
TomasHubelbauer:tom/9372-document-exclude-include
Jun 5, 2023
Merged

Document Exclude behavior, Include overrides and the default exclusion list#9376
jekyllbot merged 5 commits intojekyll:masterfrom
TomasHubelbauer:tom/9372-document-exclude-include

Conversation

@TomasHubelbauer
Copy link
Copy Markdown
Contributor

@TomasHubelbauer TomasHubelbauer commented May 30, 2023

This is a 🔦 documentation change.

Summary

I've documented the difference between Exclude in Jekyll 3 and Jekyll 4 as well as the fact that Include can override the Exclude entries.

The exclusion list is taken from a _config.yml as generated via jekyll new.

image

Context

Closes #9372.

…n list

I've documented the difference between Exclude in Jekyll 3 and Jekyll 4 as well as that Include can override the Exclude entries.

The exclusion list is taken from a `_config.yml` as generated via `jekyll new`.
<br />
In Jekyll 4, it adds to it instead and Include 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>:
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've tested this locally and the list here is taken from that _config.yml.

@ashmaroli
Copy link
Copy Markdown
Member

@TomasHubelbauer The term "Include" can be ambiguous as to what exactly is being intended — config key include / files inside _includes / the literal English word "include".
Therefore, readability may be improved by using explicit phrases such as configuration option include (where include is within single backticks).

This is in response to PR feedback raising a potential issue with the prose.
@TomasHubelbauer
Copy link
Copy Markdown
Contributor Author

@ashmaroli great point! I have turned all instances of Include and Exclude where they refer to the configuration options to inline code spans and improved the prose around them.

TomasHubelbauer and others added 2 commits June 2, 2023 22:20
Now that I am referring to the actual names of the configuration options and now the headers in the documentation, I need to switch from title case to lowercase as that's how they are named themselves.
@ashmaroli
Copy link
Copy Markdown
Member

Thanks @TomasHubelbauer.
@jekyllbot: merge +doc

@jekyllbot jekyllbot merged commit 11987c6 into jekyll:master Jun 5, 2023
jekyllbot added a commit that referenced this pull request Jun 5, 2023
@TomasHubelbauer TomasHubelbauer deleted the tom/9372-document-exclude-include branch June 5, 2023 12:45
github-actions bot pushed a commit that referenced this pull request Jun 5, 2023
Tomáš Hübelbauer: Document Exclude behavior, Include overrides and the default exclusion list (#9376)

Merge pull request 9376
@jekyll jekyll locked and limited conversation to collaborators Jun 4, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs]: Document whether exclude in _config.yml replaces or appends to the default exclusions

3 participants