Releases: Balancingrock/classic-jekyll-theme
Support for Jekyll 4.0.0
Release 2.5.0 has relaxed the requirements on the Jekyll version to include Jekyll 4.0.0.
For more on the update to Jekyll 4.0.0 read the Jekyll update guide
Apologies: In the previous release note I stated something wrong, I have removed the mistaken line.
Release 2.4.2
This release addresses an omission that was made when creating v2.0.
Up to now it was not possible to specify the color of a menu item when it was selected, though it was possible to specify the background color. This has now been fixed.
The files _sass/classic/_menubar.scss
has undergone a few minor updates, and in the file _sass/classic-jekyll-theme.scss
some additions have been made.
To keep the naming of items harmonised, the ...item-hover-color-...
names have been converted into ...item-color-hover-...
A page over creating cron-jobs (on MacOS) to facilitate automatic site generation has been added (under the menu item ‘Jekyll’)
And lastly the version numbers for bundler and rake have been updated.
All of these are minor updates that can be skipped if the new feature is not used. However the renaming of the harmonised items will affect future updates.
Bugfix
Just after releasing 2.4.0 a bug was found when creating the vertical menu.
This release fixes that bug.
Release 2.4.0
Added the capability to create menu entries from a post.
See release notes at: Release 2.4.0 (2019-01-15)
Release 2.3.0
This release adds the ability to delay the publication of a page until a specified date.
It works just like the Jekyll build-in feature for posts. I.e. add the YAML front matter date
to a page, and that page will only be included if the build time of the site is after the date specified in the front matter. However the --future
option does not work for pages with a date in the future.
Technically speaking the page will be generated, but it will be empty and there will be no menu structure pointing to it. Hence if there is no explicit link to it, it will remain invisible to the user.
This feature allows the creation of websites using a cron job to automatically create & deliver site updates at predetermined dates.
See jekyll -> cron job for more information on cron jobs.
Bug fixes and usability improvements
This release fixes some bugs and improves usability.
Bugfixes
- Highlighting of the menu path elements for the page displayed did not work correctly. Some menu items were not highlighted.
- Added missing code to the generation of highlighting in the vertical menu.
Improvements
- It is now possible to generate a subsub-menu structure from multiple places. Double sub-items will no longer be generated.
- Added an automatic horizontal scrollbar to the code sections.
- A sub-menu in the vertical menu will stay open when a subsub-menu page is visible.
Issues
This release closes the following issue's: 14, 15, 16 & 17
Known problems
The youtube-player widget will display in front of all other visible elements. This can cause lengthy menu lists to disappear below the video. Or, when banner-position: top-fixed
is used, the video will scroll over the banner.
Unfortunately there is no known solution, other than including youtube video's via an iframe:
<iframe src="https://www.youtube.com/embed/video-identifier"></iframe>
It will be necessary to specify a width and height for the video.
Bugfix for #11 and #13
This release fixes issues #11 and #13
There is a small additional benefit that fixing #13 also created the opportunity for a slight performance improvement that may be noticeable on sites that use many pages.
The changed files are:
- _includes/menubar.html
- _includes/widgets/categories.html
This release is fully backward compatible with the previous release. Upgrading is recommended for all users.
Note for Rubygems users: due a mixup this release is identical to release 2.1.1 on rubygems.
Major new release
Just over a year has gone by since the first Classic release. Since then lots of detail has been added and bugfixes have been made.
With version 2.0 we have implemented more features and added more configuration options. The code base for this theme was updated considerably. Reimplemented may be a better phrasing. The result is a better readable, better documented code base. Even the readability of the generated HTML code has been improved substantially. We believe this will make it even easier to do your own customization.
More good news is that the YAML of the old version still works. So it is not necessary to update existing content.
In addition, this theme is now used to generate its own website at github.io: http://balancingrock.github.io/classic-jekyll-theme/index.html
Bugfix
The number of posts on the home page was incorrectly set, resulting in an inclusion of all posts on the home page.
The bug was fixed by an update to the layout file 'home.html'.
Please make sure to update your own copy of this file if you have made changes to it.
Maintenance and anchored submenu items
Changes
- Version constraint on jekyll-data from 0.4 up to < 2.0 (Ashmaroli)
- Requires at least jekyll 3.5.1 (Ashmaroli)
- Typo's fixed (David Crossley)
- Added older-posts.html widget (Rien)
- Added image to posts (Rien)
- Added support for sub-menu links with anchor id's. Allows multiple sub-menu entries per file. (Rien)
Anchored sub-menu's
In addition to the existing method there is now another way to generate the sub-menu items. This method is especially handy if multiple sub-menu entries must be made for a single page using Anchor-Id's.
An example that creates multiple anchored sub menu entries:
---
...
menuInclude: yes
menuTopTitle: Classic
menuSubs:
-
title: Sub Menu Title
index: 3
anchorId: id-of-html-tag
url: /pages/menupage.html
-
title: '-------'
index: 4
link: no
-
title: Menu title below separator
index: 5
anchorId: second-anchor
...
---
The fields of the menuSubs YAML tag are interpreted as follows:
title
: The title of the submenu item in the drop down menu.index
: The place of the submenu item within the dropdown menu. Lower numbers will go above higher numbers. This theme only sorts on menuIndex numbers, not on other properties.anchorId
: The id of an HTML tag that the link will be made to. Do not include the '#' tag as this is gerenated automatically. I.e. the relative URL of the first entry above will be:/pages/menupage.html#id-of-html-tag
.url
: The url of the page to link to. If no url is specified it will link to the page this YAML matter is in.link
: Set to 'no' to disable a link creation from the navigation bar to this page. However the submenu title will be included. The default behaviour assumes 'yes'. So not including this tag will create a link. Note: This probably only makes sense if some kind of "divider" must be shown (like in the above example). Otherwise showing a submenu item without a link will probably confuse users.
Of course the anchor IDs must also be present in some HTML tag otherwise the shown page will simply default to the top of the document. An example that defines an anchor: <h3 id="second-anchor">...</h3>
Regards,
Rien.