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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update blank_template for Jekyll #9334

Closed
wants to merge 1 commit into from

Conversation

danielhaim1
Copy link
Contributor

@danielhaim1 danielhaim1 commented Apr 6, 2023

Summary

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.

Context

  • 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.

Notes

  • This is a 馃檵 feature or enhancement.
  • This is a 馃敠 documentation change.

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.
@ashmaroli
Copy link
Member

Thank you for taking the time to propose changes, @danielhaim1.
But the blank template was meant be as non-opinionated / codeless as possible; not inject more code.

Sorry, but rejecting this.

@ashmaroli ashmaroli closed this Apr 6, 2023
@danielhaim1
Copy link
Contributor Author

@ashmaroli, I suggest we reconsider the decision to reject the updates. These updates do not make the code more complex and actually include improvements to naming conventions and commented-out examples that aim to reduce reliance on documentation.

Currently, there is an inconsistency between the default.html and config.yml files with regard to the lang option. Although {{ site.lang | default: "en-US" }} is present in default.html, the lang option is not included in config.yml.

Here are the key points of the update:

  • The update addresses this inconsistency and adds basic technical examples to help users better understand the template's functionality.
  • config.yml is updated to include the lang option and other basic options. It clarifies how {{ site.lang | default: "en-US" }} is handled using the site.lang already used in default.html.

Another simple update has been made to the main.scss file for better clarity. The file now includes comments to explain its purpose and how it should be used:

Before:

---
---

@import "base";

After:

---

# Leave to compile

---

@import "base";

The comments make it clear that the --- should be left and all SCSS styles should be imported in their respective files and included through the @import directive.

I have made some reduction to the last update. Let me know your thoughts.

@jekyll jekyll locked and limited conversation to collaborators Apr 7, 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