awesome-jekyll-theme 0.0.4 → 0.2.0

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.
Files changed (3) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +81 -14
  3. metadata +7 -7
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 3a0b7635661a89039764b40c32b188a00b63f9a4bac4a985e92692b6ba3aeba1
4
- data.tar.gz: 163c06ec1e975f36e79d53351d03cb50a5bef16d036c931fefb24592f4cce00f
3
+ metadata.gz: 3ab076a5da391e511bf7ebe46d524a8b813d049986c128b6b48acdd0e94649c2
4
+ data.tar.gz: 79585bc48f6330c4f32974cf611f6e6d28daa39f16cd768914abe66b3be0654f
5
5
  SHA512:
6
- metadata.gz: 2c27d13326798c21b43d0d8c75830375d15c70c8c550320eae7a27171a0c94bd9070096c1c9bc98f74a8be813a49f2639395ed770b5db0fc438285ab137c5cd2
7
- data.tar.gz: e22ca92cf8bb311935bc1de508d1aa3a7ff28117537004449ca2623cc07712cf6372c7c65b4438e514d90e741835ff07ac62a030e5a3ab0ddf8a5546a07cb2ca
6
+ metadata.gz: 1782db45f1bbc9b80fc6fc0744b88666da934d34a06613926437a282aa9c7797e10e7ff355aa67afe5dd5f0088b0af5d8795d8f96cf61625c4e223e9f8632491
7
+ data.tar.gz: 87f563432395c64692c4aeea46956dc2fce2978cc3336b35a037b06c7cd79ca7d6fcd369eafb7ce4d74762c528f4cede8db1dce89daef640514e011acb1e4e54
data/README.md CHANGED
@@ -1,12 +1,20 @@
1
+ <div style="display: flex; flex-direction: column; justify-content: center; align-items: center; height: 50px;">
2
+
1
3
  <a href="https://jekyll-themes.com/a-chacon/awesome-jekyll-theme">
2
4
  <img
3
5
  src="https://img.shields.io/badge/featured%20on-JT-red.svg"
4
- height="20"
5
6
  alt="Jekyll Themes Shield"
6
7
  />
7
8
  </a>
8
9
 
9
- # Awesome Jekyll Theme
10
+ ![GitHub Pages](https://github.com/a-chacon/awesome-jekyll-theme/actions/workflows/jekyll.yml/badge.svg?branch=main)
11
+ ![GitHub License](https://img.shields.io/github/license/a-chacon/awesome-jekyll-theme)
12
+ ![Gem Downloads (for latest version)](https://img.shields.io/gem/dtv/awesome-jekyll-theme)
13
+ ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/a-chacon/awesome-jekyll-theme)
14
+
15
+ </div>
16
+
17
+ # Awesome Jekyll Theme 🎉
10
18
 
11
19
  A clean, versatile Jekyll theme with minimalist design and robust features.
12
20
  Ideal for portfolios, blogs, and project showcases with responsive layouts and easy customization.
@@ -37,27 +45,86 @@ Ideal for portfolios, blogs, and project showcases with responsive layouts and e
37
45
 
38
46
  5. **Category-based organization** for blog posts, allowing for easy content discovery and improved site structure.
39
47
 
40
- ## Installation
48
+ ## Installation: The Easy Way to Have Your Site on GitHub Pages (Recommended!) 😄
41
49
 
42
- Add this line to your Jekyll site's `Gemfile`:
50
+ 1. **Navigate to the Main Page of the Repository**
43
51
 
44
- ```ruby
45
- gem "awesome-jekyll-theme"
46
- ```
52
+ On GitHub.com, go to the main page of the repository at [awesome-jekyll-theme](https://github.com/a-chacon/awesome-jekyll-theme).
47
53
 
48
- And add this line to your Jekyll site's `_config.yml`:
54
+ 2. **Click 'Use this Template'**
49
55
 
50
- ```yaml
51
- theme: awesome-jekyll-theme
52
- ```
56
+ Click the "Use this template" button above the file list and select "Create a new repository."
57
+
58
+ 3. **Set Repository Details**
59
+
60
+ - Select the owner of the repository.
61
+ - Type a name for your repository. If you want the site to be available at `https://YOURUSERNAME.github.io`, name it `YOURUSERNAME.github.io` (replace `YOURUSERNAME` with your GitHub username). Otherwise, you can choose any name you prefer, and the site will be available at `https://YOURUSERNAME.github.io/REPOSITORYNAME`.
62
+ - Add an optional description.
63
+ - Choose repository visibility.
64
+
65
+ 4. **Create Repository from Template**
66
+
67
+ Click "Create repository from template."
68
+
69
+ 5. **Enable GitHub Pages**
70
+
71
+ To deploy the site on GitHub Pages, enable it in your repository settings. Go to **Settings -> Pages -> Source** and select `GitHub Actions`.
72
+
73
+ 6. **Customize Your Website Settings**
74
+
75
+ Edit the `_config.yml` file to change any settings you want. The settings in the file are self-explanatory, and there are comments inside to help you understand what each setting does. After making changes, click the "Commit changes" button to save them.
76
+
77
+ 7. **Congratulations! You Have a Website!**
53
78
 
54
- And then execute:
79
+ If you named the repository `YOURUSERNAME.github.io`, your website should be ready in a minute or two at `https://YOURUSERNAME.github.io`. If you used a different name, your website will be available at `https://YOURUSERNAME.github.io/REPOSITORYNAME`. Every time you make a change to any file, your website will be rebuilt and updated in about a minute.
55
80
 
81
+ ## Advanced Installation (Optional) ⚙️
82
+
83
+ 1. **Create a New Jekyll Site**
84
+
85
+ If you don’t already have a Jekyll site, create one with:
86
+
87
+ ```bash
88
+ jekyll new my-site
89
+ ```
90
+
91
+ Then, navigate into your new site’s directory:
92
+
93
+ ```bash
94
+ cd my-site
95
+ ```
96
+
97
+ 2. **Add the Theme to Your Gemfile**
98
+
99
+ Open your `Gemfile` and add this line:
100
+
101
+ ```ruby
102
+ gem "awesome-jekyll-theme"
103
+ ```
104
+
105
+ 3. **Update Your `_config.yml`**
106
+
107
+ In your `_config.yml` file, add this line:
108
+
109
+ ```yaml
110
+ theme: awesome-jekyll-theme
111
+ ```
112
+
113
+ 4. **Install the Theme**
114
+
115
+ Run the following command to install the theme and its dependencies:
116
+
117
+ ```bash
56
118
  bundle
119
+ ```
120
+
121
+ 5. **Run Your Site**
57
122
 
58
- Or install it yourself as:
123
+ Start your Jekyll site with:
59
124
 
60
- gem install awesome-jekyll-theme
125
+ ```bash
126
+ bundle exec jekyll serve
127
+ ```
61
128
 
62
129
  ## Usage
63
130
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: awesome-jekyll-theme
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.4
4
+ version: 0.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - a-chacon
8
- autorequire:
8
+ autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-07-22 00:00:00.000000000 Z
11
+ date: 2024-07-30 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jekyll
@@ -66,7 +66,7 @@ dependencies:
66
66
  - - "~>"
67
67
  - !ruby/object:Gem::Version
68
68
  version: 2.8.0
69
- description:
69
+ description:
70
70
  email:
71
71
  - andres.ch@protonmail.com
72
72
  executables: []
@@ -114,7 +114,7 @@ homepage: https://github.com/a-chacon/awesome-jekyll-portfolio
114
114
  licenses:
115
115
  - MIT
116
116
  metadata: {}
117
- post_install_message:
117
+ post_install_message:
118
118
  rdoc_options: []
119
119
  require_paths:
120
120
  - lib
@@ -129,8 +129,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
129
129
  - !ruby/object:Gem::Version
130
130
  version: '0'
131
131
  requirements: []
132
- rubygems_version: 3.4.22
133
- signing_key:
132
+ rubygems_version: 3.4.10
133
+ signing_key:
134
134
  specification_version: 4
135
135
  summary: A clean, versatile Jekyll theme with minimalist design and robust features.
136
136
  Ideal for portfolios, blogs, and project showcases with responsive layouts and easy