featherweight 0.3 → 0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +23 -12
- data/_layouts/default.html +5 -1
- data/_layouts/post.html +9 -0
- metadata +6 -6
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 5cdc9adb1d2b5e894c80880ade6429240cf021e03df2ad6f76c64a2bbdfac2b9
|
|
4
|
+
data.tar.gz: 3ccbec7f3efdd98350ec08f14e645d9c3e2cdf16a6fbf7b2667279c715f731ff
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 4edba29b59ebf561d7ea1e21aa8e638e00d2502a779b02bb8b1d59f3a35074b945c7db0a776083eb4ec9c4f123f39636a839fa70e42004aa42522f932e6f9aca
|
|
7
|
+
data.tar.gz: 82c20c98cda30b96c5bba17b7227e594914d38cbc1ef952d9bd005353f1fadfc854316f6d2b66a87ea14dc495e62adc33d0e3f6d957923e62e1c997774658997
|
data/README.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
[ruby-gems]: https://rubygems.org/gems/featherweight
|
|
6
6
|
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
#### Replacing X with Y
|
|
9
9
|
|
|
10
10
|
|X|Y|
|
|
11
11
|
|:--:|:--:|
|
|
@@ -13,26 +13,37 @@
|
|
|
13
13
|
|Post styling|[Reader view](https://support.mozilla.org/en-US/kb/firefox-reader-view-clutter-free-web-pages)|
|
|
14
14
|
|Sharing links|_Copy/paste the URL_|
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
#### Building on GitHub
|
|
17
17
|
|
|
18
|
-
|
|
19
|
-
2. Update `_pages/about.md` with an introduction.
|
|
20
|
-
3. Write some blogs, using `_posts/test.md` as a template.
|
|
21
|
-
4. You're ready to host your minimalist site!
|
|
18
|
+
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).
|
|
22
19
|
|
|
23
|
-
|
|
20
|
+
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/)).
|
|
24
21
|
|
|
25
|
-
|
|
22
|
+
The workflow pushes the build to `gh-pages` branch by default, so make sure this exists and your page settings point towards it.
|
|
23
|
+
|
|
24
|
+
#### Writing blog posts
|
|
26
25
|
|
|
27
|
-
|
|
26
|
+
Create a blank `.md` file in `_pages/`, and add:
|
|
27
|
+
```
|
|
28
|
+
---
|
|
29
|
+
layout: post
|
|
30
|
+
title: My blog post.
|
|
31
|
+
---
|
|
32
|
+
```
|
|
28
33
|
|
|
29
|
-
|
|
34
|
+
Write your blog post in GitHub-flavoured-markdown below the metadata.
|
|
30
35
|
|
|
31
|
-
|
|
36
|
+
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](https://jekyllrb.com/docs/posts/).
|
|
37
|
+
|
|
38
|
+
#### Cheatsheet
|
|
32
39
|
|
|
33
40
|
|||
|
|
34
41
|
|:--:|:--:|
|
|
42
|
+
| _Config_ | Update site URL, personal links, CV experience using `_config.yml`. |
|
|
43
|
+
| _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. |
|
|
44
|
+
| _About me_ | Customise the About Me section of the homepage by editing `_pages/about.md`. |
|
|
45
|
+
| _Change font_ | Customise fonts for text + footer by editing `_layouts/default.html` and `_layouts/post.html` inline CSS. |
|
|
35
46
|
| _RSS_ | The RSS feed can be found at <https://yourgithubusername.github.io/feed>. |
|
|
36
47
|
| _Sitemap_ | The sitemap can be found at <https://yourgithubusername.github.io/sitemap>. |
|
|
37
48
|
| _Quickstart_ | Test your website locally by following the [Jekyll quickstart guide](https://jekyllrb.com/docs/). |
|
|
38
|
-
|
|
49
|
+
|
data/_layouts/default.html
CHANGED
|
@@ -8,10 +8,14 @@ layout: compress
|
|
|
8
8
|
<meta name="viewport" content="width=device-width,initial-scale=1.0">
|
|
9
9
|
<link rel="alternate" type="application/rss+xml" title="{{ site.name }}" href="{{ site.url }}/feed.xml" />
|
|
10
10
|
|
|
11
|
-
{% if site.favicon %}
|
|
11
|
+
{% if site.compression.favicon %}
|
|
12
12
|
<link rel="icon" type="image/png" sizes="32x32" href="{{ site.url }}/{{ site.favicon }}">
|
|
13
13
|
{% else %}
|
|
14
14
|
<link rel="icon" href="data:,">
|
|
15
15
|
{% endif %}
|
|
16
16
|
|
|
17
|
+
{% if site.compression.styling %}
|
|
18
|
+
<body style="font-family:sans-serif;max-width:18cm;padding:8mm 16mm;text-align:justify;text-justify:inter-word;">
|
|
19
|
+
{% endif %}
|
|
20
|
+
|
|
17
21
|
{{ content }}
|
data/_layouts/post.html
CHANGED
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
---
|
|
2
2
|
layout: default
|
|
3
3
|
---
|
|
4
|
+
{% if site.compression.menu %}
|
|
5
|
+
<a href="{{ site.url }}/" style="position:absolute;top:0;left:0;">Home</a>
|
|
6
|
+
{% endif %}
|
|
7
|
+
|
|
4
8
|
<b>{{ page.title }}</b><br><i> Written on {{ page.date | date: "%B %e, %Y" }} </i>
|
|
5
9
|
{{ content }}
|
|
10
|
+
|
|
11
|
+
{% if site.compression.footer %}
|
|
12
|
+
<hr>
|
|
13
|
+
<p style="font-family:monospace;">{% for link in site.personals %}{{ link.name }}: <a href="{{ link.url }}">{{ link.url }}</a><br>{% endfor %}
|
|
14
|
+
{% endif %}
|
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.
|
|
4
|
+
version: '0.4'
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Zachary Smith
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2022-09-
|
|
11
|
+
date: 2022-09-23 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: jekyll
|
|
@@ -114,16 +114,16 @@ dependencies:
|
|
|
114
114
|
name: jekyll-loading-lazy
|
|
115
115
|
requirement: !ruby/object:Gem::Requirement
|
|
116
116
|
requirements:
|
|
117
|
-
- - "
|
|
117
|
+
- - "~>"
|
|
118
118
|
- !ruby/object:Gem::Version
|
|
119
|
-
version:
|
|
119
|
+
version: 0.1.1
|
|
120
120
|
type: :runtime
|
|
121
121
|
prerelease: false
|
|
122
122
|
version_requirements: !ruby/object:Gem::Requirement
|
|
123
123
|
requirements:
|
|
124
|
-
- - "
|
|
124
|
+
- - "~>"
|
|
125
125
|
- !ruby/object:Gem::Version
|
|
126
|
-
version:
|
|
126
|
+
version: 0.1.1
|
|
127
127
|
description:
|
|
128
128
|
email:
|
|
129
129
|
- zachsmith.dev@gmail.com
|