jekyll-theme-linky 0.1.1 → 0.1.2
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 +39 -7
- data/_includes/custom-head.html +6 -2
- data/_includes/head.html +0 -1
- metadata +3 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 27af5bc99da98b31436165534ede095c02dbd8faf9c743b1e67889d66983919e
|
|
4
|
+
data.tar.gz: b5a3a4b60b5b08814dee425f3c69553d60082d32a31c76bf4f9e4b9f06e71ad8
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: f16cc7b9a2cebee1c4714c6031d2802bf386593b33d6b5b42cc59c9cf61bf79da3925e9b66c6d42d0297195a2b008adf9a35773603d79ed87f8ae6b7c9721a99
|
|
7
|
+
data.tar.gz: bdf68557fd13cd9037a5467986f9ff9b2b0f11b18ba6ce9fca8e41e2a8155b3b96bdb3c74a92afab9f7a34fac9a463e12726730cc831e9064ff607ea323a501e
|
data/README.md
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
# linky
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A linktree-esque theme, built for static hosting and easy maintenance with [Decap CMS][decap].
|
|
4
|
+
|
|
5
|
+
<picture>
|
|
6
|
+
<source srcset="images/linky-home.webp" type="image/webp">
|
|
7
|
+
<img src="images/linky-home.png" alt="Linky Home Page">
|
|
8
|
+
</picture>
|
|
4
9
|
|
|
5
10
|
## Installation
|
|
6
11
|
|
|
@@ -26,11 +31,9 @@ Or install it yourself as:
|
|
|
26
31
|
|
|
27
32
|
## Usage
|
|
28
33
|
|
|
29
|
-
Use the [links layout][ll] on any page (including the home page) to display a list of all items in the `links` collection. Any additional content
|
|
30
|
-
within your page will be displayed after the list.
|
|
34
|
+
Use the [links layout][ll] on any page (including the home page) to display a list of all items in the `links` collection. Any additional content within your page will be displayed after the list.
|
|
31
35
|
|
|
32
|
-
The `links` collection is defined by individual files in the `_links` folder. Only the YAML frontmatter of these files will be used; content
|
|
33
|
-
is unnecessary and will be ignored.
|
|
36
|
+
The `links` collection is defined by individual files in the `_links` folder. Only the YAML frontmatter of these files will be used; content is unnecessary and will be ignored.
|
|
34
37
|
|
|
35
38
|
You will need to add a `links` collection to your Jekyll config, which is as simple as adding
|
|
36
39
|
|
|
@@ -58,8 +61,7 @@ subheads:
|
|
|
58
61
|
|
|
59
62
|
### Colors
|
|
60
63
|
|
|
61
|
-
You can override the color scheme of a Links page by adding a `linky` section to your `_config.yml` (see [the example in this repo][config]) and
|
|
62
|
-
setting one or more of these values:
|
|
64
|
+
You can override the color scheme of a Links page by adding a `linky` section to your `_config.yml` (see [the example in this repo][config]) and setting one or more of these values:
|
|
63
65
|
|
|
64
66
|
```yml
|
|
65
67
|
linky:
|
|
@@ -111,6 +113,28 @@ expires: 2024-11-11
|
|
|
111
113
|
Note that this will only take effect on a rebuild; there's no runtime JavaScript, etc. to disable a link that's already been deployed.
|
|
112
114
|
|
|
113
115
|
|
|
116
|
+
## Update Links with Decap CMS
|
|
117
|
+
|
|
118
|
+
The whole point of this exercise (as opposed to adding links by hand or using a database-backed site) was to add/update links via a CMS, but still serve static HTML for the usual speed and safety reasons.
|
|
119
|
+
|
|
120
|
+
In my case, I'm using [Decap CMS][decap] and [Netlify][netlify]. The Decap view for [linky.roub.net][linky-home] looks like this:
|
|
121
|
+
|
|
122
|
+
<picture>
|
|
123
|
+
<source srcset="images/decap-home.webp" type="image/webp">
|
|
124
|
+
<img src="images/decap-home.png" alt="Decap CMS Home Page">
|
|
125
|
+
</picture>
|
|
126
|
+
|
|
127
|
+
Clicking on one of those links takes me to the detail page:
|
|
128
|
+
|
|
129
|
+
<picture>
|
|
130
|
+
<source srcset="images/decap-detail.webp" type="image/webp">
|
|
131
|
+
<img src="images/decap-detail.png" alt="Decap CMS Detail Page">
|
|
132
|
+
</picture>
|
|
133
|
+
|
|
134
|
+
See the [admin folder][admin] for the relevant configuration, as well as the JS that allows for a custom preview styles (which just uses the site's CSS).
|
|
135
|
+
|
|
136
|
+
Most of the admin's [config.yml][admin-config] will be the same regardless of your Decap setup, but some of the integration details (authorization, etc.) will differ if you're not using the same setup that I am. See the [Decap docs][decap-netlify] for information on the drop-in setup I'm using.
|
|
137
|
+
|
|
114
138
|
## Contributing
|
|
115
139
|
|
|
116
140
|
Bug reports and pull requests are welcome on GitHub at https://github.com/paulroub/linky. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://www.contributor-covenant.org/) code of conduct.
|
|
@@ -122,3 +146,11 @@ The theme is available as open source under the terms of the [MIT License](https
|
|
|
122
146
|
|
|
123
147
|
[ll]: https://github.com/paulroub/linky/blob/main/_layouts/links.html
|
|
124
148
|
[config]: https://github.com/paulroub/linky/blob/main/_config.yml
|
|
149
|
+
[linky-home]: https://linky.roub.net/
|
|
150
|
+
[decap-home-image]: images/decap-home.png
|
|
151
|
+
[decap-detail-image]: images/decap-detail.png
|
|
152
|
+
[netlify]: https://netlify.com/
|
|
153
|
+
[decap]: https://decapcms.org/
|
|
154
|
+
[decap-netlify]: https://decapcms.org/docs/choosing-a-backend/#setup-on-netlify
|
|
155
|
+
[admin]: https://github.com/paulroub/linky/blob/main/admin/
|
|
156
|
+
[admin-config]: https://github.com/paulroub/linky/blob/main/admin/config.yml
|
data/_includes/custom-head.html
CHANGED
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
{% comment %}
|
|
2
|
-
|
|
2
|
+
Add any extra head information here, e.g. your own favicons. None of the content below is required for your own site.
|
|
3
3
|
|
|
4
4
|
1. Head over to https://realfavicongenerator.net/ to add your own favicons.
|
|
5
|
-
2.
|
|
5
|
+
2. Add _includes/custom-head.html in your source directory and insert the given code snippet.
|
|
6
6
|
{% endcomment %}
|
|
7
|
+
|
|
8
|
+
<link rel="icon" href="/favicon.ico" sizes="any">
|
|
9
|
+
<link rel="icon" href="/linky.svg" type="image/svg+xml">
|
|
10
|
+
<link rel="apple-touch-icon" href="/apple-touch-icon.png">
|
data/_includes/head.html
CHANGED
|
@@ -3,7 +3,6 @@
|
|
|
3
3
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
4
4
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
5
5
|
{%- seo -%} {%- feed_meta -%}
|
|
6
|
-
<link rel="icon" href="/favicon.ico" sizes="any" />
|
|
7
6
|
|
|
8
7
|
<link rel="stylesheet" href="/assets/styles.css" />
|
|
9
8
|
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: jekyll-theme-linky
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1.
|
|
4
|
+
version: 0.1.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Paul Roub
|
|
@@ -68,7 +68,8 @@ files:
|
|
|
68
68
|
homepage: http://github.com/paulroub/linky
|
|
69
69
|
licenses:
|
|
70
70
|
- MIT
|
|
71
|
-
metadata:
|
|
71
|
+
metadata:
|
|
72
|
+
source_code_uri: https://github.com/paulroub/linky/
|
|
72
73
|
post_install_message:
|
|
73
74
|
rdoc_options: []
|
|
74
75
|
require_paths:
|