Improve documentation for config options #760
Conversation
This update to _config.yml tries to avoid some confusion I ran into after choosing Minima as the theme for my GH Pages site. I did not want to build locally, but let GitHub do the job. Here are the changes I made: - Since GH Pages still uses Minima 2.5.1, I added a block on how to use the latest Minima version anyway. - My header_pages did not show up in the specified order. It was an indentation error, for some reason I thought that it is a minima setting (minima.header_pages). I placed it before the minima block to avoid this confusion. - The skin setting is missing in the current default _config.yml, I added it here.
There was a problem hiding this comment.
I'm on board with this in general. I left one inline comment.
Would you mind updating the PR title to be a short sentence describing your changes? PR titles get used in History.markdown. Something like Improve documentation for config options or something like that would be ideal.
Thanks for your contribution! ❤️
_config.yml
Outdated
| # Minima date format. | ||
| # Refer to https://shopify.github.io/liquid/filters/date/ if you want to customize this. | ||
| # | ||
| # date_format: "%b %-d, %Y" | ||
| date_format: "%b %-d, %Y" |
There was a problem hiding this comment.
I didn't see this change described in your PR description. Was it intentional to uncomment this? If not, would you mind recommenting it? Thanks!
There was a problem hiding this comment.
Yes, I forgot about that, sorry, it was late. The idea was, that the config file should reflect the sample site (https://jekyll.github.io/minima/). I just tested it, and it seems that the default date value is "%b %d, %Y" anyway (I couldn't find out what the minus before the day means, it seems to do nothing). I would therefor suggest, to comment the line again, but switch it to a format which is not the default (we could mention the default in the comment above).
Because789
changed the title
Here is a commit with the suggested changes to the date format block. I also fixed the consistency of the spelling of minima: "Minima" in comments, "minima" in settings.
This update to _config.yml tries to avoid some confusion I ran into after choosing Minima as the theme for my GH Pages site. I did not want to build locally, but let GitHub do the job. Here are the changes I made: