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

Updates for blank_template #9337

Closed
wants to merge 2 commits into from

Conversation

danielhaim1
Copy link
Contributor

Please refer to #9334 for additional notes.

Updated config.yml, index.md, header.html, main.scss, and default.html to include additional site settings, improved ordering and variable names, and better styling.

- Updated the config.yml file to include additional site settings and build settings, as well as comments to explain each setting.
Added a basic description to the index.md file.
- Improved the header.html file to include a better ordering of the meta tags and added a default_page_title variable to the site settings.
- Improved the main.scss file to include more robust font fallbacks and better variable names.
- Updated the default.html file to include a more robust ordering of meta tags and improved styling links.
- Removed unnecessary `config.yml`
- Simplified if/else, removed `role="main"`
- Modernized `base.scss`
@ashmaroli
Copy link
Member

Please copy-paste relevant notes from the previous PR onto this one. Visitors to this thread are not going to want to jump across two pull request threads (with very similar diff) to gain context.

Once again, I really wish you'd understand that "verbosity" is not what is expected with a "blank" scaffolding. I am definitely not in favor of having (some of the default) config settings regurgitated under the garb of better onboarding.

If there actual onboarding issues with Jekyll's scaffolding templates, please open an "issue" ticket or if you are inclined on explaining stuff, please feel free to improve Jekyll's documentation site.

@danielhaim1
Copy link
Contributor Author

I am definitely not in favor of having (some of the default) config settings regurgitated under the garb of better onboarding.

I understand that verbosity is not desired for a blank scaffolding, but the updates made in this PR were primarily focused on addressing an inconsistency between the default.html and config.yml files, outdated syntax, and improving naming conventions and comments to help reduce reliance on external documentation. While I understand your concern about regurgitating default config settings, the added comments in config.yml were included to help new contributors understand how the file should be structured once additional code is added. However, if the comments are causing you that much confusion or you see them as that unnecessary, we can certainly remove them.

@danielhaim1
Copy link
Contributor Author

I'm going to close this pull request due to the test results. I realize this requires additional work.

@danielhaim1 danielhaim1 closed this Apr 9, 2023
@danielhaim1 danielhaim1 deleted the blank_template branch April 11, 2023 20:23
@jekyll jekyll locked and limited conversation to collaborators Apr 10, 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.

None yet

3 participants