featherweight 0.7.6 → 0.7.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c25658af1e00516586d0f43e7840cfe7021966ac800c9ea81be265a86d85f171
-  data.tar.gz: c6a257a2c77ef1a538b51be6f963e9f2b3630cb55a84ac4d0c21cf26dc938c95
+  metadata.gz: fca04b8b438ce67b53d54288ea26f7f57d400303af58da7b36ea3ea3b5b358ff
+  data.tar.gz: da14d652024d26781a3c920c4d0cb130ccc62896932270ede6bd3835dc140624
 SHA512:
-  metadata.gz: 50b1a7c28f3f188c94555ae6831c18a810a24be5bc2751379d6d8d28f66d2469c2b623697cd01c48826dd71ffb715f3770fe3f8de3b8aa67bd1e57d4231372d5
-  data.tar.gz: e43af8085752a8ca4f96b6f849810d6562b51ad176b338a763d63b345d25d6eafab11bf21721d0c70d49d627633d75f4ea97b01614514d1646ba8ffc12d6eb8c
+  metadata.gz: f3976ecf1167095bdc902970e7e3ad5592e4d8fab77ad23f3120ba618a8db5cd72324da9d1e3b41029a0224ef68aaf86f51827e45c3acddf0d7e0b520243d511
+  data.tar.gz: 60e2b5307ddc4b06d93350dbbbab430489ede50095e64fd3cb1cb8be0ea9627f6aae031e5d1d3194f7cf4554dbe48ef6825e93eafb2a171dbd4562fde559c5fe

data/README.md

@@ -10,7 +10,28 @@ If you're using this site on GitHub pages, the built-in build action won't run g
 
 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/)).
 
-The workflow pushes the build to `gh-pages` branch by default, so make sure this exists and your page settings point towards it.
+The workflow pushes the build to `gh-pages` branch, so make sure this exists and your GitHub page is set to deploy from this branch.
+
+#### Featherweight as a remote theme
+
+`Featherweight` can be used as a remote theme, enabling integration into existing projects.
+We recommend using the same action setup as described above, but using the [Cutwell/jekyll-build-action](https://github.com/Cutwell/jekyll-build-action) action, to support the theme gem's dependence on Ruby 3.0.0.
+
+Copy the `_config.yml` file into your repository root, adding the following markup to specify the theme:
+```yml
+theme: featherweight
+```
+
+Also create a `Gemfile` file in the repository root, with the following content:
+```Gemfile
+source "https://rubygems.org"
+
+gem 'featherweight', '~> 0.7.6'
+```
+
+Additionally, copy the `index.md` and `_includes/contact.md` files, and customise them to personalise your site.
+
+With this setup, the theme will now build and install. See [Cutwell/cutwell.github.io](https://github.com/Cutwell/cutwell.github.io) for an example of this theme being used remotely.
 
 #### Writing blog posts
 
@@ -40,7 +61,7 @@ When naming blog post files, use the `YYYY-MM-DD-title.md` convention, or else y
 | _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). |
-| _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. |
+| _Page reflow protection_ | To prevent page-reflow whilst lazy-loading images, we set image height and width using `Cutwell/jekyll-anti-image-reflow` gem 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.
@@ -59,9 +80,15 @@ Many of these are entirely optional settings. If you're looking to create a trul
 | _Favicons_ | Generate icons for your site using [https://realfavicongenerator.net/](https://realfavicongenerator.net/), or disable favicons using `_config.yml` to use a low-byte-count alternative. Change file names or theme colours using `_config.yml`. |
 
 #### Dev
+_Build locally_
 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`
 
+_Build .gem_
+1. Update version in `.gemspec`
+2. Build with `gem build featherweight.gemspec`
+3. Push to RubyGem with `gem push featherweight-x.x.x.gem`
+
 #### Credit
 feather by GREY Perspective from <a href="https://thenounproject.com/browse/icons/term/feather/" target="_blank" title="feather Icons">Noun Project</a>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: featherweight
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.7.7
 platform: ruby
 authors:
 - Zachary Smith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-27 00:00:00.000000000 Z
+date: 2023-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll