Skip to content

Beautiful Jekyll v5.0.0
Compare
Choose a tag to compare
@daattali daattali released this 15 Sep 22:20
· 176 commits to master since this release
5.0.0
d585986

One of the major changes in this version is that a lot of time was spent on rethinking the entire SEO and social media sharing model (how a page looks on eg. Google, Twitter, Facebok). It was redesigned to be more simple and customizable. The new documentation has a section dedicated to SEO and social media sharing of a page. Unfortunately some changes that are not backwards-compatible had to be made.

Breaking changes

  • Renamed description YAML parameter to share-description to be more clear
  • Renamed description config setting to rss-description since it was only used in RSS (the FAQ explains the difference between YAML parameters and config settings if you're confused)
  • Removed YAML parameter use-site-title (you can now specify the exact title using share-title)
  • Removed undocumented YAML parameters meta-title and meta-description
  • Removed link-tags config setting because it wasn't necessary. If you use tags, there will now always be a tags page created; if you don't use tags there won't be a tags page.
  • The YAML parameter show-avatar is now true by default. This has always been the case for GitHub Pages users, but not for remote_theme users. For consistency, it's now the default for everyone. (#715)

New parameters and settings

  • Added full-width YAML parameter to allow having full-width pages
  • Added feed_show_excerpt config setting to show/hide the post excerpts on the feed page
  • Added feed_show_tags config setting to show/hide the list of tags on post previews on the feed page
  • Added share-title YAML parameter to give control over the search engine/social media title
  • Added last-updated YAML parameter to show a "Last Updated on" date for blog posts
  • Added before-content and after-content YAML parameters that allow you to add some common HTML before the main content of a page (below the title) or after the main content (above the footer). Works in a similar way to footer-extra.
  • Added head-extra YAML parameter which is similar to footer-extra but is used to include custom HTML code in a page's <head> tag
  • Added site-js config setting to provide JavaScript files that are used on all pages in the site

New features and improvements

  • Improved the footer-extra YAML parameter to support multiple files instead of only a single file
  • Added automatic navbar color detection (#702)
  • When nav-short is turned on, the avatar will also be shorter
  • Changed navbar and footer background colour to be slightly darker, for better contrast with the default white page background for accessibility reasons
  • Changed the behaviour of site-css to include site-wide CSS file before instead of after page-specific files
  • Renamed internal css/js files from "main" to "beautifuljekyll" to make it easier for users to troubleshoot
  • Added alt text to all images for better accessibility
  • Made thumbnail images square instead of circles, as users reported that circles cut off important parts of images

Bug fixes

  • Fixed rendering issues with nav-short parameter that caused the body of the page to start too low
  • Fixed some CSS styles that broke during the bootstrap 4 migration (#716)

Library upgrades

  • Upgraded kramdown to version 2.3.0 to fix security issues
  • Upgraded jQuery to version 3.5.1 to fix a couple security vulnerabilities with the previous version
Assets 2
Loading