Dean Attali
4 years ago
1 changed files with 39 additions and 24 deletions
Split View
Diff Options
-
+39 -24CHANGELOG.md
+ 39
- 24
CHANGELOG.md
View File
| @@ -1,32 +1,47 @@ | |||
| ## Unreleased version | |||
| 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 had to be made that are not backwards-compatible. | |||
| - **BREAKING CHANGE** Renamed `description` YAML option to `share-description` to be more clear | |||
| - **BREAKING CHANGE** Renamed `description` config parameter to `rss-description` since it was only used in RSS (the FAQ in the README explains the difference between YAML options and config parameters if you're confused!) | |||
| - **BREAKING CHANGE** Removed YAML option `use-site-title` (you can now specify the exact title using `share-title`) | |||
| - **BREAKING CHANGE** Removed undocumented YAML options `meta-title` and `meta-description` | |||
| - **BREAKING CHANGE** Removed `link-tags` config parameter because it wasn't necessary. If you use tags, there will be a tags page created; if you don't use tags there is no tags page. | |||
| - **BREAKING CHANGE** The YAML setting `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) | |||
| - Added `share-title` YAML option to give control over the search engine/social media title | |||
| - Added `before-content` and `after-content` YAML options 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 option which i s similar to `footer-extra` but is used to include custom HTML code in a page's `<head>` tag | |||
| - Added `full-width` YAML option to allow having full-width pages | |||
| - Added `feed_show_excerpt` config option to show/hide the post excerpts on the feed page | |||
| - Added `feed_show_tags` config option to show/hide the list of tags on post previews on the feed page | |||
| 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 parameter to `rss-description` since it was only used in RSS (the FAQ explains the difference between YAML parameters and config parameters 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 parameter 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 setting `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 | |||
| - Added `full-width` YAML parameter to allow having full-width pages | |||
| - Added `feed_show_excerpt` config parameter to show/hide the post excerpts on the feed page | |||
| - Added `feed_show_tags` config parameter 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 `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 | |||
| #### 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) | |||
| - Added a blank template CSS file `assets/css/custom.css` that's automatically included in all pages that can be used to overwrite any default Beautiful Jekyll ruless | |||
| - When `nav-short` is turned on, the avatar will also be shorter | |||
| - Fixed rendering issues with `nav-short` option that caused the body of the page to start too low | |||
| - Improved the `footer-extra` YAML option to support multiple files instead of only a single file | |||
| - 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 | |||
| - Added automatic navbar color detection (#702) | |||
| - Changed navbar and footer background colour to be slightly darker, for better contrast with the default white page background | |||
| - Changed the behaviour of `site-css` to include site-wide CSS file **before** page-specific files | |||
| - 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 | |||
| #### 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 | |||
| ## v4.1.0 (2020-08-08) | |||
| - Added Open Graph `site_name` meta field to pages automatically | |||
| @@ -34,7 +49,7 @@ One of the major changes in this version is that a lot of time was spent on reth | |||
| - Added `keywords` config setting to set the meta keywords on all pages (for SEO purposes) (#691) | |||
| - Added `mobile-theme-col` config setting to allow a mobile theme colour (#692) | |||
| - Added `site-css` config setting in the config file to provide CSS files that are used on all pages in the site (#695) | |||
| - Added YAML option `description`: creates the meta description on a page, intended to provide a brief description of the page for search engines and when the page is shared (#690) | |||
| - Added YAML parameter `description`: creates the meta description on a page, intended to provide a brief description of the page for search engines and when the page is shared (#690) | |||
| ## v4.0.1 (2020-07-13) | |||
| @@ -70,9 +85,9 @@ One of the major changes in this version is that a lot of time was spent on reth | |||
| ## v2.3.0 (2020-04-29) | |||
| - Added YAML option `footer-extra` for including custom content in the footer | |||
| - Added YAML parameter `footer-extra` for including custom content in the footer | |||
| - Fixed issue: linking to a specific part of a page resulted in scrolling too far (#69) | |||
| - Added YAML option `nav-short` to have navbar permanently collapsed | |||
| - Added YAML parameter `nav-short` to have navbar permanently collapsed | |||
| - Added social network link: Calendly | |||
| - Fixed bug where RSS link in footer was showing even when turned off | |||