Include configuration syntax for hidden folders

[assombrance]

Motivation

Hi, I've struggled (like a lot of persons it seems) with setting up github pages with shpinx. In particular, the way include works on folders/subfolders.

To solve the problem, I went to the documentation and looked how it was done in the default configuration here. And either the syntax is not the same for include or exclude, either there is a typo in the documentation:

To exclude a folder, it seems like one needs to write:

exclude: ["folder_name/"]

But it did not work to include a folder (specifically a folder starting with an underscore).
After some testing and looking around, I found that the syntax for include seems to be:

include: ["_special_folder_name"]

Suggestion

It is quite frustrating to have to guess that I find. Maybe an update of the documentation would be needed ?

A great way to improve the doc would be to give examples, at least for that case, but also maybe for and command/option (the default configuration is quite helpful for that, but it wasn't enough for me this time).

Thanks !

[DirtyF]

Thanks for reporting.

Looks like a bug to me, I manage to reproduce it:

Given I have a _pages folder containing a 404.html file
And I have includes: _pages/ in my _config.yml
When I run jekyll build
Then 404.html is not generated in the destination folder.

Works fine if I remove the ending slash in the includes directive.

@jekyll/build any idea why this discrepancy here?

[DirtyF]

includes and excludes should work the same, it shouldn't matter if you add the trailing slash or not.
So I would say the latter, with associated configuration tests . 🙏

[kartikcho]

It seems this is not a mere documentation issue and I'm not familiar with the codebase so this could take long for me. I'm sure someone else would fix it faster than me. Sorry @DirtyF

[billykong]

Hi @DirtyF, I would like to work on this issue if you don't mind. I have been reading through the code yesterday and I believe I have an idea how to fix this issue.

It would be my first issue and will probably take a week for me to submit the first pull request.

[DirtyF]

👌 Thanks for offering your help @billykong, feel free to open a draft pull request, expose how you want to solve the problem before implementing it if you need any guidance.

[billykong]

Hi @DirtyF, thank you very much. I have linked a draft pull request to this issue. The implementation is there since doesn't involve much code. Feel free to comment or modify it as you see fit.