- Example 1: This repo builds directly to GitHub pages, which is also the documentation: https://sfreytag.github.io/friday-theme/
- Example 2: my own homepage, http://www.freytag.org.uk
For Jekyll 4.* on localhost, clone this repo then from within it:
Set baseurl to ""
in _config.yml
then run:
bundle install
bundle exec jekyll serve
Follow the install notes.
The theme is free to use, but if you do use it, it would be great to hear from you. Email simon@freytag.org.uk - thanks!
This theme uses {{site.baseurl}}
throughout for compatibility with GitHub Pages running Jekyll 3.9 where the site is served out of a folder - eg https://sfreytag.github.io/friday-theme/
It also works with Jekyll 4.* and where the site is served out of the root of the domain - eg https://www.freytag.org.uk
However, this means you cannot use Jekyll 4.* and a folder - the base URL will get repeated in the links. For Jekyll 4.* you must serve it from the root of the domain.
Look at _config.yml
and the baseurl
setting.
In May 2025 this theme was upgraded to use Bootstrap 5. To upgrade your older FridayTheme to also use Bootstrap 5, look back through the commits on the main branch. In brief, you need to:
- Add the Bootstrap 5.2.3 SCSS files
- Update site.scss to load Boostrap 5
- Update classes. The theme needs
ml-
,mr-
,border-left-
andborder-right-
to be updated toms-
,me-
,border-start-
, andborder-end-
. You might have added other classes that need updating. - Replace the JS with the Bootstrap 5.3 compiled JS files
- Update the class
sr-only
tovisually-hidden
- Fix the components that use JS. This mostly requires attributes like
data-toggle
to becomedata-bs-toggle
- Remove the Masonry /
.card-columns
layout if you were using it Unfortunately Bootstrap5 no longer supports it. - Add a rule to
_variables.scss
to remove link underlines - Remove the old Boostrap SCSS files
You may be able to achieve this by merging this up into your own homepage, if it has not diverged too far away from it.