Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Don't ship _config.yml #40

Merged
merged 1 commit into from
Jan 3, 2021
Merged

Don't ship _config.yml #40

merged 1 commit into from
Jan 3, 2021

Conversation

michaelpj
Copy link
Contributor

If the config file is included in the gem, then it will be applied to
users' site configurations alongside their own configuration.

This doesn't provide much benefit, since most of the configuration
options are either a) not applicable to users (e.g. the title setting),
or b) easily set by users to their own preferences (e.g. the markdown
settings).

Furthermore, some of the settings are actively harmful. In particular the paginate
options are from the old jekyll-paginate. In recent versions of
Jekyll, setting the old options causes build failures for users who are
using the newer jekyll-paginate-v2.

Overall, I think it's useful to have _config.yml in the repository as
an example, but I don't think we should ship it.

If the config file is included in the gem, then it will be applied to
users' site configurations alongside their own configuration.

This doesn't provide much benefit, since most of the configuration
options are either a) not applicable to users (e.g. the title setting),
or b) easily set by users to their own preferences (e.g. the markdown
settings).

Furthermore, some of the settings are actively harmful. In particular the `paginate`
options are from the old `jekyll-paginate`. In recent versions of
Jekyll, setting the old options causes build failures for users who are
using the newer `jekyll-paginate-v2`.

Overall, I think it's useful to have `_config.yml` in the repository as
an example, but I don't think we should ship it.
@yous yous merged commit 40eab70 into yous:master Jan 3, 2021
@yous
Copy link
Owner

yous commented Jan 3, 2021

Thanks for pointing this out. I'll release a new version of the gem soon.

@michaelpj
Copy link
Contributor Author

Thank you! No need to hurry on my behalf, I've worked around it locally for now :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants