wind-theme 0.1.3 → 0.1.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +77 -25
  3. data/assets/css/main.scss +2 -0
  4. metadata +3 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e169a3fa24d3eb7e75a294dbccb38e719633cae7cdaf4231f6615d36682acf56
4
- data.tar.gz: 6b02d03319a8cab71f2230300a9826cdb311777d39539bdff2adfef573f140f0
3
+ metadata.gz: 56efefefc7ed8fa5ec17a098ce96aa10bb40c23e3490a022072e7d156545e50c
4
+ data.tar.gz: a7a8e3fce68058ae074b72c28dd6dd23dae25775aff0060d00d3d15ad91a97d9
5
5
  SHA512:
6
- metadata.gz: ab5493fd7bad4b651a980bbdb0451aede91ca7683789e28038172ba7ceee15af429a709d0a2b8a4cb46dd48f96bcef2539e05f449638a113298083d0b303163a
7
- data.tar.gz: f08d190d74742f06f2ba40bc48053b8fb9e6883c556727e48b4cfb0ba03bb48f6935bafe2dc0feff32804e910566970a245e00ae2c0a701ea7ad339b03edb265
6
+ metadata.gz: b5e8034796c2b1fe0b1775b69dfb0558ce50bc5c0df21934b93ebae0dab65140fb50ddadfd7cc484c70dc5c08bad23b716cde462d3687763fd408e589c0da7b5
7
+ data.tar.gz: aa4fb456408fa52320dbdb3d4a388c86d0984cccb3172310003385e8bd75a38bf6c14725fc56ad7427a522ddcd6ff75473eb48f03b1cdb198b10c9dcdaa7d9d9
data/README.md CHANGED
@@ -1,11 +1,19 @@
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/wind">
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
 
10
+ ![GitHub Pages](https://github.com/a-chacon/wind/actions/workflows/jekyll.yml/badge.svg?branch=main)
11
+ ![GitHub License](https://img.shields.io/github/license/a-chacon/wind)
12
+ ![Gem Downloads (for latest version)](https://img.shields.io/gem/dtv/wind-theme)
13
+ ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/a-chacon/wind)
14
+
15
+ </div>
16
+
9
17
  # Wind: A Minimalistic, Simple, and Beautiful Blogging Theme
10
18
 
11
19
  If you like it please think on supporting my job:
@@ -60,42 +68,86 @@ Wind is a clean, minimalistic Jekyll theme designed to offer a delightful bloggi
60
68
 
61
69
  13. **Author Profile:** Personalize your blog by adding an author profile section, allowing you to share information about yourself and connect with your audience on a more personal level.
62
70
 
63
- ## Installation
71
+ ## Installation: The Easy Way to Have Your Site on GitHub Pages (Recommended!) 😄
64
72
 
65
- To use the Wind Jekyll theme as a Ruby Gem in your Jekyll site, follow these steps:
73
+ 1. **Navigate to the Main Page of the Repository**
66
74
 
67
- 1. **Add Wind Gem to your Gemfile:** Open your Jekyll project's `Gemfile` and add the following line to the `jekyll_plugins` group:
75
+ On GitHub.com, go to the main page of the repository at [wind-theme](https://github.com/a-chacon/wind).
68
76
 
69
- ```ruby
70
- gem "wind-theme"
71
- ```
77
+ 2. **Click 'Use this Template'**
72
78
 
73
- 2. **Install Gems:** In your project's root directory, run the following command to install the Wind Gem and its dependencies:
79
+ Click the "Use this template" button above the file list and select "Create a new repository."
74
80
 
75
- ```
76
- bundle install
77
- ```
81
+ 3. **Set Repository Details**
78
82
 
79
- 3. **Configure Wind Theme:** Open your Jekyll project's \_config.yml file, and set the theme key to "wind":
83
+ - Select the owner of the repository.
84
+ - 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`.
85
+ - Add an optional description.
86
+ - Choose repository visibility.
80
87
 
81
- ```yalm
82
- theme: wind-theme
83
- ```
88
+ 4. **Create Repository from Template**
84
89
 
85
- 4. **Use the layouts provided by the theme:** open your index.md or index.markdown page of your jekyll site and put it on the Front Matter section:
90
+ Click "Create repository from template."
86
91
 
87
- ```
88
- ---
89
- layout: home
90
- ---
92
+ 5. **Enable GitHub Pages**
91
93
 
92
- ```
94
+ To deploy the site on GitHub Pages, enable it in your repository settings. Go to **Settings -> Pages -> Source** and select `GitHub Actions`.
93
95
 
94
- 5. **Local Development:** Run the following command to preview your Jekyll site locally:
96
+ 6. **Customize Your Website Settings**
95
97
 
96
- ```
97
- bundle exec jekyll serve
98
- ```
98
+ 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.
99
+
100
+ 7. **Congratulations! You Have a Website!**
101
+
102
+ 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.
103
+
104
+ ## Advanced Installation (Optional) ⚙
105
+
106
+ 1. **Create a New Jekyll Site**
107
+
108
+ If you don’t already have a Jekyll site, create one with:
109
+
110
+ ```bash
111
+ jekyll new my-site
112
+ ```
113
+
114
+ Then, navigate into your new site’s directory:
115
+
116
+ ```bash
117
+ cd my-site
118
+ ```
119
+
120
+ 2. **Add the Theme to Your Gemfile**
121
+
122
+ Open your `Gemfile` and add this line:
123
+
124
+ ```ruby
125
+ gem "wind-theme"
126
+ ```
127
+
128
+ 3. **Update Your `_config.yml`**
129
+
130
+ In your `_config.yml` file, add this line:
131
+
132
+ ```yaml
133
+ theme: wind-theme
134
+ ```
135
+
136
+ 4. **Install the Theme**
137
+
138
+ Run the following command to install the theme and its dependencies:
139
+
140
+ ```bash
141
+ bundle
142
+ ```
143
+
144
+ 5. **Run Your Site**
145
+
146
+ Start your Jekyll site with:
147
+
148
+ ```bash
149
+ bundle exec jekyll serve
150
+ ```
99
151
 
100
152
  ## Usage
101
153
 
data/assets/css/main.scss CHANGED
@@ -4,11 +4,13 @@
4
4
  @font-face {
5
5
  font-family: 'Adamina';
6
6
  src: url({{ "/assets/Adamina/Adamina-Regular.ttf" | relative_url }});
7
+ font-display: swap;
7
8
  }
8
9
 
9
10
  @font-face {
10
11
  font-family: 'OpenSans';
11
12
  src: url({{ "/assets/Open_Sans/static/OpenSans-Regular.ttf" | relative_url }});
13
+ font-display: swap;
12
14
  }
13
15
 
14
16
  $primary_color: {{ site.color | default: "#a505f0" }};
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: wind-theme
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.3
4
+ version: 0.1.4
5
5
  platform: ruby
6
6
  authors:
7
7
  - a-chacon
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-07-08 00:00:00.000000000 Z
11
+ date: 2025-01-31 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jekyll
@@ -143,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
143
143
  - !ruby/object:Gem::Version
144
144
  version: '0'
145
145
  requirements: []
146
- rubygems_version: 3.4.22
146
+ rubygems_version: 3.4.10
147
147
  signing_key:
148
148
  specification_version: 4
149
149
  summary: Wind is a clean, minimalistic Jekyll theme designed to offer a delightful