Featherweight is an ultra-lightweight Jekyll theme, aiming to minimise bandwidth usage and deliver a bare-bones experience (page sizes of ~1kb).
Replacing X with Y
| X | Y |
|---|---|
| Blog search | ctrl+f |
| Post styling | Reader view |
| Sharing links | Copy/paste the URL |
Building on GitHub
If you're using this site on GitHub pages, the built-in build action won't run gems outside of the supported plugins list, e.g.: the jekyll-loading-lazy gem (which adds loading="lazy" tags to iframes and img tags, enabling faster initial page loads).
To enable these gems, use the build_and_deploy.yml action under .github/workflows to automatically build your site on pushes, which circumvents this restriction while still hosting using GitHub pages (as advised by Jekyll).
The workflow pushes the build to gh-pages branch by default, so make sure this exists and your page settings point towards it.
Writing blog posts
Create a blank .md file in _pages/, and add:
---
layout: post
title: My blog post.
---
Write your blog post in GitHub-flavoured-markdown below the metadata.
When naming blog post files, use the YYYY-MM-DD-title.md convention, or else your post won't appear in the blog post list. Read the Jekyll docs.
Cheatsheet
| Config | Update site URL, personal links, CV experience using _config.yml. |
| Extra config | Customise your site (add minimal inline styling, homepage link and footer in blogposts, favicon) via the compression options in _config.yml. These options add additional bytes to your pages, but can improve UX. |
| About me | Customise the About Me section of the homepage by editing _pages/about.md. |
| Change font | Customise fonts for text + footer by editing _layouts/default.html and _layouts/post.html inline CSS. |
| RSS | The RSS feed can be found at https://yourgithubusername.github.io/feed. |
| Sitemap | The sitemap can be found at https://yourgithubusername.github.io/sitemap. |
| Quickstart | Test your website locally by following the Jekyll quickstart guide. |
| GZip compression | Files are compressed using Zopfli compression. GitHub GZip's files automatically before serving, but we can use more aggressive pre-compression to achieve better compression, and avoid server overhead to compress on-the-fly. |