linkhub-jekyll-theme 0.1.0 → 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 67f892b470219d665a6b54744f081a80c8b7a1e25273531f32e2db2c46404719
4
- data.tar.gz: 5e8731c201b61adbc6e04c51c8092bfadec373aa6b52c2697be720e97179e30b
3
+ metadata.gz: 0b9d95a9edea729c8a367dc0b77a44374ed059b9fd63066bd547b03f0b9aedd6
4
+ data.tar.gz: bed3f8f1c9dd29562c5e79da814fe10803904e318006896582e0e75ec990204c
5
5
  SHA512:
6
- metadata.gz: 69329c5b9e48f57719b1a4277fe8f050a19392389248d2c421d06c156b438c2b2691ad4e2e69c3b1f356009f9ac4aa49c9e753a14dbd60b922b0b53b034134fe
7
- data.tar.gz: 140dd5dff7fa74e70f985a51095152c5b23ac73e55e072fa3369948372bc09f73f6cf7dec11ae46b76910a192046daf7c54926ce89dc8e108543feb0889ba1df
6
+ metadata.gz: e7112d435d34e08142c7b9994dc5efe017e5dd78eabbda8a3dbd4093cb21a342c8e71af5cc422f4f6d112b75464e7f625ab343a45af6a3229958cdb50b6f9475
7
+ data.tar.gz: 32e43dbbd495e6be67626c821d029943d7760d28daaef4bf38790d6593543d453cff22f0e5ae18ea0bea850b87396620cbea89d6441a0937442a52725b0f36a6
data/README.md CHANGED
@@ -1,12 +1,33 @@
1
- <div align="center">
2
-
3
- # Linkhub
4
-
5
- A minimal and super-lightweight, free Jekyll theme to create a single-page, link-in-bio website like Linktree or Later.
6
-
7
- [**Live Demo ◉**](https://digitalmalayali.github.io/linkhub-jekyll-theme/)
8
-
9
- </div>
1
+ <h1 align="center">
2
+ <strong>Linkhub</strong>
3
+ </h1>
4
+
5
+ <p align="center">
6
+ <a href="https://jekyllrb.com">
7
+ <img src="https://img.shields.io/badge/jekyll-~%3E%204.3-grey?logo=jekyll&labelColor=%23CC0000" alt="Jekyll version">
8
+ </a>
9
+ <a href="https://rubygems.org/gems/linkhub-jekyll-theme">
10
+ <img src="https://img.shields.io/gem/v/linkhub-jekyll-theme?logo=ruby&logoColor=%23E9573F" alt="Gem (including prereleases)">
11
+ </a>
12
+ <a href="https://rubygems.org/gems/linkhub-jekyll-theme">
13
+ <img src="https://img.shields.io/gem/dt/linkhub-jekyll-theme?logo=ruby&logoColor=%23E9573F" alt="Gem">
14
+ </a>
15
+ <a href="https://liberapay.com/zcraber">
16
+ <img src="https://img.shields.io/badge/liberapay-donate-F6C915?logo=liberapay&logoColor=%23F6C915" alt="Gem">
17
+ </a>
18
+ </p>
19
+
20
+ <p align="center">A minimal and super-lightweight, free Jekyll theme to create a single-page, link-in-bio website like Linktree or Later.</p>
21
+
22
+ <p align="center">
23
+ <img src="https://github.com/digitalmalayali/linkhub-jekyll-theme/assets/61133303/9c861ba3-90fe-45c6-a87d-af01152b17bb" alt="mockup">
24
+ </p>
25
+
26
+ <p align="center">
27
+ <a href="https://digitalmalayali.github.io/linkhub-jekyll-theme/">
28
+ <strong>Live Demo ◉</strong>
29
+ </a>
30
+ </p>
10
31
 
11
32
  ## Features
12
33
  - 😊 Based on the original [Linkhub](https://github.com/digitalmalayali/Linkhub) template!
@@ -18,6 +39,26 @@ A minimal and super-lightweight, free Jekyll theme to create a single-page, link
18
39
 
19
40
  ## Installation
20
41
 
42
+ There are multiple ways to install and set up Linkhub. Let's explore each of them.
43
+
44
+ ### Use GitHub Template (Fastest Way)
45
+
46
+ If you need the quickest way to set this up or if you're a complete beginner to Jekyll, using the GitHub template is the easiest option. You can also fork the repo.
47
+
48
+ 1. Visit [Linkhub theme repository](https://github.com/digitalmalayali/linkhub-jekyll-theme).
49
+ 2. Click the **Use this template** button.
50
+ 3. Select **Create a new repository**.
51
+ 4. Give it a name and click **Create repository**.
52
+ 5. Edit the `_config.yml` and `_data` files for customization. Check the [Usage](https://github.com/digitalmalayali/linkhub-jekyll-theme#usage) guide for details.
53
+ 6. Go to **Settings** > **Pages**. Under **Build and deployment**, select **GitHub Actions** as the source.
54
+ 7. If you have a [custom domain](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/), you can enter it. Otherwise, you can view the published website at GitHub.io once the building is complete!
55
+
56
+ ### Install as GitHub Remote Theme
57
+
58
+ Go to your site's `_config.yml` and replace `theme:` with `remote_theme: digitalmalayali/linkhub-jekyll-theme`.
59
+
60
+ ### Install as Ruby Gem
61
+
21
62
  Add this line to your Jekyll site's `Gemfile`:
22
63
 
23
64
  ```ruby
@@ -38,27 +79,27 @@ Or install it yourself as:
38
79
 
39
80
  $ gem install linkhub-jekyll-theme
40
81
 
41
- ## Usage
42
- Linkhub is super-easy to use!
82
+ ## Customization
83
+ Linkhub is super-easy to customize!
43
84
 
44
- ### Adding site info
45
- Edit the `_config.yml` file to specify your website's name, page title, description, and whether to show/hide the verified badge. This information will also be used for meta tags.
85
+ ### Adding Site Info
86
+ Edit the `_config.yml` file to specify your website's name, page title, description, Google Analytics and whether to show/hide the verified badge. This information will also be used for meta tags.
46
87
 
47
- ### Adding icons
88
+ ### Adding Icons
48
89
  Icons are powered by the free and open-source icon framework [Iconify](https://github.com/iconify), offering a selection of over 150,000 icons. Visit the [Iconify icon sets website](https://icon-sets.iconify.design/) to search for your preferred icon. Once you find your desired icon, copy its name and use it in the respective fields.
49
90
 
50
- ### Adding social media links
91
+ ### Adding Social Media Links
51
92
  Edit the `social.yml` file in the `_data` folder to add your social media profiles, along with your preferred icons and colors.
52
93
 
53
- ### Adding Instagram/TikTok/YouTube etc link-in-bio
54
- Like Later's link-in-bio feature, you can include external links to your Instagram, TikTok, and other posts by adding name of social media, the link and image URL/path to `bio.yml` in the `_data` folder. You can either upload thumbnails of your Instagram, TikTok and YouTube posts to an image hosting service or create an `images` folder in `assets` and place them there. The image size doesn't matter, and it will be displayed similarly to a 3-column Instagram grid.
94
+ ### Adding Instagram/TikTok/YouTube Link-in-bio
95
+ Like Later's link-in-bio feature, you can include external links to your Instagram, TikTok, and other posts by adding the name of social media, the link and image URL/path to `bio.yml` in the `_data` folder. You can either upload thumbnails of your Instagram, TikTok and YouTube posts to an image hosting service or create an `images` folder in `assets` and place them there. The image size doesn't matter, and it will be displayed similarly to a 3-column Instagram grid.
55
96
 
56
- ### Adding links
97
+ ### Adding Links
57
98
  Edit the `links.yml` file in the `_data` folder to add link categories, links, icons, and tags. Refer to the provided examples and the [demo](https://digitalmalayali.github.io/linkhub-jekyll-theme/) for a better understanding.
58
99
 
59
100
  ## Contributing
60
101
 
61
- Bug reports and pull requests are welcome on [GitHub](https://github.com/digitalmalayali/linkhub-jekyll-theme).
102
+ Bug reports and pull requests are welcome on [GitHub](https://github.com/digitalmalayali/linkhub-jekyll-theme). If you like this theme, please give it a star!
62
103
 
63
104
  ## Development
64
105
 
data/_config.yml CHANGED
@@ -1,10 +1,14 @@
1
+ # Jekyll
2
+ theme: linkhub-jekyll-theme
3
+
1
4
  # Site Configuration
2
- name: 'Linkhub' # Name of your website
3
- tagline: 'Links' # Set your preferred page title
4
- description: 'A free, open-source Jekyll link-in-bio theme.' # Also used as a meta description
5
- favicon: 'https://picsum.photos/100' # Path / URL to the favicon of your website (e.g., 'assets/images/favicon.png')
6
- logo: 'https://picsum.photos/200' # Path / URL to the logo (e.g., 'assets/images/logo.png')
5
+ name: Linkhub # Name of your website
6
+ tagline: Links # Set your preferred page title
7
+ description: A free, open-source Jekyll link-in-bio theme. # Also used as a meta description
8
+ favicon: https://picsum.photos/100 # Path / URL to the favicon of your website (e.g., 'assets/images/favicon.png')
9
+ logo: https://picsum.photos/200 # Path / URL to the logo (e.g., 'assets/images/logo.png')
7
10
  url: https://link.example.com # URL of your website
11
+ ga4: G-XXXXXXX # Google Analytics 4 measurement ID (optional). Remove it if not needed.
8
12
  twitter:
9
13
  username: username # Used for SEO
10
14
  card: summary
@@ -32,4 +36,4 @@ defaults:
32
36
  layout: "default"
33
37
 
34
38
  # Exclude
35
- exclude: [README.md, Gemfile.lock, .jekyll-cache/, Gemfile]
39
+ exclude: [README.md, Gemfile.lock, .jekyll-cache/, .github/, Gemfile, LICENSE.txt, funding.yml, linkhub-jekyll-theme.gemspec]
@@ -0,0 +1,9 @@
1
+ <!-- Google tag (gtag.js) -->
2
+ <script async src="https://www.googletagmanager.com/gtag/js?id={{ site.ga4 }}"></script>
3
+ <script>
4
+ window.dataLayer = window.dataLayer || [];
5
+ function gtag(){dataLayer.push(arguments);}
6
+ gtag('js', new Date());
7
+
8
+ gtag('config', '{{ site.ga4 }}');
9
+ </script>
@@ -2,6 +2,9 @@
2
2
  <html lang="en">
3
3
 
4
4
  <head>
5
+ {% if site.ga4 %}
6
+ {% include ga4.html %}
7
+ {% endif %}
5
8
  <meta charset="UTF-8">
6
9
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
7
10
  <title>{{ site.tagline }} - {{ site.name }}</title>
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: linkhub-jekyll-theme
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Digital Malayali
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-10-03 00:00:00.000000000 Z
11
+ date: 2023-10-04 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jekyll
@@ -38,6 +38,20 @@ dependencies:
38
38
  - - "~>"
39
39
  - !ruby/object:Gem::Version
40
40
  version: 2.8.0
41
+ - !ruby/object:Gem::Dependency
42
+ name: bundler
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '2.4'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '2.4'
41
55
  description:
42
56
  email:
43
57
  - social@digitalmalayali.in
@@ -53,6 +67,7 @@ files:
53
67
  - _data/social.yml
54
68
  - _includes/bio.html
55
69
  - _includes/footer.html
70
+ - _includes/ga4.html
56
71
  - _includes/links.html
57
72
  - _includes/social.html
58
73
  - _layouts/default.html
@@ -77,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
77
92
  - !ruby/object:Gem::Version
78
93
  version: '0'
79
94
  requirements: []
80
- rubygems_version: 3.4.10
95
+ rubygems_version: 3.4.20
81
96
  signing_key:
82
97
  specification_version: 4
83
98
  summary: A minimal and super-lightweight free Jekyll theme to create a link-in-bio