featherweight 0.7.6 → 0.7.7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +29 -2
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: fca04b8b438ce67b53d54288ea26f7f57d400303af58da7b36ea3ea3b5b358ff
|
|
4
|
+
data.tar.gz: da14d652024d26781a3c920c4d0cb130ccc62896932270ede6bd3835dc140624
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: f3976ecf1167095bdc902970e7e3ad5592e4d8fab77ad23f3120ba618a8db5cd72324da9d1e3b41029a0224ef68aaf86f51827e45c3acddf0d7e0b520243d511
|
|
7
|
+
data.tar.gz: 60e2b5307ddc4b06d93350dbbbab430489ede50095e64fd3cb1cb8be0ea9627f6aae031e5d1d3194f7cf4554dbe48ef6825e93eafb2a171dbd4562fde559c5fe
|
data/README.md
CHANGED
|
@@ -10,7 +10,28 @@ If you're using this site on GitHub pages, the built-in build action won't run g
|
|
|
10
10
|
|
|
11
11
|
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/)).
|
|
12
12
|
|
|
13
|
-
The workflow pushes the build to `gh-pages` branch
|
|
13
|
+
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.
|
|
14
|
+
|
|
15
|
+
#### Featherweight as a remote theme
|
|
16
|
+
|
|
17
|
+
`Featherweight` can be used as a remote theme, enabling integration into existing projects.
|
|
18
|
+
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.
|
|
19
|
+
|
|
20
|
+
Copy the `_config.yml` file into your repository root, adding the following markup to specify the theme:
|
|
21
|
+
```yml
|
|
22
|
+
theme: featherweight
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Also create a `Gemfile` file in the repository root, with the following content:
|
|
26
|
+
```Gemfile
|
|
27
|
+
source "https://rubygems.org"
|
|
28
|
+
|
|
29
|
+
gem 'featherweight', '~> 0.7.6'
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Additionally, copy the `index.md` and `_includes/contact.md` files, and customise them to personalise your site.
|
|
33
|
+
|
|
34
|
+
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.
|
|
14
35
|
|
|
15
36
|
#### Writing blog posts
|
|
16
37
|
|
|
@@ -40,7 +61,7 @@ When naming blog post files, use the `YYYY-MM-DD-title.md` convention, or else y
|
|
|
40
61
|
| _Quickstart_ | Test your website locally by following the [Jekyll quickstart guide](https://jekyllrb.com/docs/). |
|
|
41
62
|
| _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`. |
|
|
42
63
|
| _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). |
|
|
43
|
-
| _Page reflow protection_ | To prevent page-reflow whilst lazy-loading images, we set image height and width using
|
|
64
|
+
| _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. |
|
|
44
65
|
|
|
45
66
|
#### Cosmetics
|
|
46
67
|
`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
|
|
|
59
80
|
| _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`. |
|
|
60
81
|
|
|
61
82
|
#### Dev
|
|
83
|
+
_Build locally_
|
|
62
84
|
1. Clone this repository: `git clone https://github.com/Cutwell/featherweight.git`
|
|
63
85
|
2. Download the project dependencies: `bundle install`
|
|
64
86
|
3. Run a local Jekyll server: `bundle exec jekyll serve`
|
|
65
87
|
|
|
88
|
+
_Build .gem_
|
|
89
|
+
1. Update version in `.gemspec`
|
|
90
|
+
2. Build with `gem build featherweight.gemspec`
|
|
91
|
+
3. Push to RubyGem with `gem push featherweight-x.x.x.gem`
|
|
92
|
+
|
|
66
93
|
#### Credit
|
|
67
94
|
feather by GREY Perspective from <a href="https://thenounproject.com/browse/icons/term/feather/" target="_blank" title="feather Icons">Noun Project</a>
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: featherweight
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.7.
|
|
4
|
+
version: 0.7.7
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Zachary Smith
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2023-01-15 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: jekyll
|