featherweight 0.5.2 → 0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f74c7dff08e726e3b1501a2bba0ac4f2be6473ae4a3c551868f77433b0660171
-  data.tar.gz: 602d895b80e20b5a7d122985e8147384353ef9c52b37c982f73cb114e61a6373
+  metadata.gz: 3eea45f44ac811dade1063f72adf7f843360bd7ac7b29f780b84dc8162cbbacc
+  data.tar.gz: 9defd546784bc1a9cec7cd44d0212ec4d47f30e3df88a84e781b2368d0e0f7aa
 SHA512:
-  metadata.gz: a08f48e3ced8c8e6c189540b1e518cec419caac09803d8bc3604acfe6c72599873164a695092b8cb59b475898f40a58cbf89516e6aa65693e559123e225f4a7a
-  data.tar.gz: cdecc86e8beecb5aabc03e87ce2f37cfd8d8bc7479a454e8107df843ab739e1caa3886efcc1e0a479bf76a34afa48721304a38d5372b1a389fa78ad22d61f19a
+  metadata.gz: e32bd724f3163e2d939742c805f357d0229d39a41aa73e2068b9ab54deca09d91c690a928f2233d08f9bf78b31e7603e3bb1125f4b2d6ee9f97d3efc6d65c9ae
+  data.tar.gz: 6e2d6c7d4d04e7e7a07a6e2547a3f45350c8c17d64030ce24c76cfceb2f32b8b3926e84b17792a5c07348516e5c7ed5bb667d15a2d0cf297efbb446ace745ad2

data/README.md

@@ -4,18 +4,9 @@
 
 [ruby-gems]: https://rubygems.org/gems/featherweight
 
-
-#### Replacing X with Y
-
-|X|Y|
-|:--:|:--:|
-|Blog search|`ctrl+f`|
-|Post styling|[Reader view](https://support.mozilla.org/en-US/kb/firefox-reader-view-clutter-free-web-pages)|
-|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](https://pages.github.com/versions/), e.g.: the `jekyll-loading-lazy` gem (which adds `loading="lazy"` tags to `iframes` and `img` tags, enabling faster initial page loads).
+If you're using this site on GitHub pages, the built-in build action won't run gems outside of the [supported plugins list](https://pages.github.com/versions/).
 
 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](https://jekyllrb.com/docs/continuous-integration/github-actions/)).
 
@@ -28,6 +19,8 @@ Create a blank `.md` file in `_pages/`, and add:
 ---
 layout: post
 title: My blog post.
+description: A description of the post, used for metadata.
+image: (optional) an image to display when linking to the post on e.g.: Twitter or Facebook
 ---
 ```
 
@@ -39,12 +32,32 @@ When naming blog post files, use the `YYYY-MM-DD-title.md` convention, or else y
 
 |||
 |:--:|:--:|
-| _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. |
+| _Config_ | Update site URL, social links, and CV experience using `_config.yml`. |
+| _About me_ | Customise the About Me section of the homepage by editing `_pages/about.md`. This is rendered as markdown at build time. |
 | _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](https://jekyllrb.com/docs/). |
 | _gzip compression_ | Files are compressed using [Zopfli](https://github.com/philnash/jekyll-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. Support seems to vary between browsers, and some will fallback to `.html`. |
-| _Brotli compression_ | We also compress files using Google's [Brotli](https://en.wikipedia.org/wiki/Brotli) algorithm. We serve `.gz` and `.html` as fallback, although `.br` [has good support](https://caniuse.com/brotli) |
+| _Brotli compression_ | We also compress files using Google's [Brotli](https://en.wikipedia.org/wiki/Brotli) algorithm. We serve `.gz` and `.html` as fallback, although `.br` [has good support](https://caniuse.com/brotli). |
+| _Page reflow protection_ | To prevent page-reflow whilst lazy-loading images, we set image height and width using the `_plugins/jekyll-anti-image-reflow.rb` plugin. Note it will not override existing styling to loading, width or height attributes. |
+
+#### Cosmetics
+`Featherweight` allows you to enable numerous cosmetic upgrades for your site. Toggle these options in the `compression` settings in `_config.yml`. These cosmetics all add to the total page weight, but can significantly improve the UX.
+
+Many of these are entirely optional settings. If you're looking to create a truly minimal webpage, read the comments inside `_config.yml`.
+
+|||
+|:--:|:--:|
+| _SEO_ | Enabling search engine optimisations will add metadata for search engines and sharing on social media. |
+| _Reading time_ | To display an estimated reading time for blog posts. |
+| _Change font_ | Customise fonts for text + footer by editing `_layouts/default.html` and `_layouts/post.html` inline CSS. |
+| _Load time_ | Show off your page load times at the foot of the homepage/blog posts. |
+| _Blog post footer_ | Display social media links below blog posts. |
+| _social-urls_, _resume_, _blogs_ | Toggle the display of each of these subsections on your homepage. |
+| _CSS_ | Add some basic styling, based on [58 bytes of CSS to look great nearly everywhere](https://gist.github.com/JoeyBurzynski/617fb6201335779f8424ad9528b72c41). Also add some basic image styling to blog posts, working in combination with `anti-image-reflow` to fit images to the blog width without causing jank. |
+| _favicon_, _icon_ | Both options require image urls. The favicon is the website icon, whilst the icon is used if the site is made into a webapp, or a shortcut on iOS devices, etc. `Favicon` accepts .ico, `icon` accepts .png of size 192x192. |
+
+#### Dev
+1. Clone this repository: `git clone https://github.com/Cutwell/featherweight.git`
+2. Download the project dependencies: `bundle install`
+3. Run a local Jekyll server: `bundle exec jekyll serve`

data/_layouts/default.html

@@ -1,21 +1,17 @@
 ---
 layout: compress
 ---
-<!DOCTYPE html>
+<!-- include header.html -->
+{% include header.html %}
 
-<title>{{ site.name }}</title>
-
-<meta name="viewport" content="width=device-width,initial-scale=1.0">
-<link rel="alternate" type="application/rss+xml" title="{{ site.name }}" href="{{ site.url }}/feed.xml" />
-
-{% if site.compression.favicon %}
-<link rel="icon" type="image/png" sizes="32x32" href="{{ site.url }}/{{ site.favicon }}">
-{% else %}
-<link rel="icon" href="data:,">
-{% endif %}
-
-{% if site.compression.styling %}
-<body style="font-family:sans-serif;max-width:18cm;padding:8mm 16mm;text-align:justify;text-justify:inter-word;">
+<!-- include page css if enabled -->
+{% if site.compression.css %}
+<body style="max-width:80ch;padding:3em 1em;margin:auto;line-height:1.6;font-size:1.25em;font-family:sans-serif">
 {% endif %}
 
 {{ content }}
+
+<!-- add page load time if enabled -->
+{% if site.compression.load-time %}
+<br><i>Page loaded in: <script>window.onload = function () {document.getElementById("loadTime").innerHTML = window.performance.timing.domContentLoadedEventEnd-window.performance.timing.navigationStart;}</script><span id="loadTime"></span>ms</i>
+{% endif %}

data/_layouts/post.html

@@ -1,14 +1,17 @@
 ---
 layout: default
 ---
-{% if site.compression.menu %}
-<a href="{{ site.url }}/" style="position:absolute;top:0;left:0;">Home</a>
+{% if site.compression.home-link %}
+<a style="position:absolute;top:0;left:0;margin:1em;color:inherit;font-size:1em;" href="{{ site.url }}">{% if site.home-link-text %}{{ site.home-link-text }}{% else %}Return Home{% endif %}</a>
 {% endif %}
 
-<b>{{ page.title }}</b><br><i> Written on {{ page.date | date: "%B %e, %Y" }} </i>
+<h1>{{ page.title }}</h1>
+<i>Written on {{ page.date | date: "%B %e, %Y" }}</i>
+<br><i>{% include reading-time.html %}</i>
+
 {{ content }}
 
 {% if site.compression.footer %}
-<hr>
-<p style="font-family:monospace;">{% for link in site.personals %}{{ link.name }}: <a href="{{ link.url }}">{{ link.url }}</a><br>{% endfor %}
-{% endif %}
+<br><hr>
+<p>{% for link in site.social-urls %}{{ link.name }}: <a href="{{ link.url }}">{{ link.url}}</a><br>{% endfor %}</p>
+{% endif %}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: featherweight
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: '0.6'
 platform: ruby
 authors:
 - Zachary Smith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-27 00:00:00.000000000 Z
+date: 2022-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -86,20 +86,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: jekyll-loading-lazy
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: jekyll-zopfli
   requirement: !ruby/object:Gem::Requirement
@@ -159,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.24
 signing_key:
 specification_version: 4
 summary: "`Featherweight` is an ultra-lightweight Jekyll theme, aiming to minimise